Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change: improve CONTRIBUTE.md #61

Merged
merged 2 commits into from
Feb 16, 2017
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 25 additions & 18 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,45 +2,52 @@

**TL;DR; Tests, coverage, linting, changelog** (See Pull Request Requirements, below).

The GraphQL Accounts project was intended - since it's inception - to be a community maintained project. We'd love to see you get involved (especially long time contributors from the Meteor community who we've worked with before).
The Accounts project was intended - since its inception - to be a community maintained project. We would love to see you get involved (especially long time contributors from the Meteor community who we've worked with before).

## Getting started
## Getting Started

1. Fork the project on Github (top right on the project page)
1. `git clone [email protected]:yourname/accounts`
1. `git checkout devel`
1. `git checkout -b proposed-feature`
1. Clone the project: `git clone [email protected]:yourname/accounts`
1. Checkout a relevant branch like: `git checkout some-branch`
1. Create your own feature branch: `git checkout -b proposed-feature`

Most packages in the project are self contained with their own tests. But if you want to use your devel copy in a project, use `npm link`:
## Development
[Install Node.js](https://nodejs.org/en/download/) to get access to `npm`.

1. In your cloned directory: `sudo npm link`
1. In your app / project: `npm start` followed by `npm link @accounts/accounts`
#### Useful Commands:
* Install project dependencies: `npm i`
* Link together all packages: `npm run link`
* Watch the packages for changes and recompile: `npm start`
* If you want to use the Account project in your own project, use `npm link`:
1. In your cloned directory: `sudo npm link`
1. In your app / project: `npm start` followed by `npm link @accounts/accounts`

## Pull Requests

### Requirements

For non-bug-fixes, please open an *issue* first and discuss your idea to make sure we're on the same page. Alternatively, prepend your PR title with `[discuss]` to have a conversation around the code.
For non-bug-fixes, please open an *issue* first and discuss your idea to make sure we're on the same page.
Alternatively, prepend your PR title with `[discuss]` to have a conversation around the code.

All PRs:
#### All PRs:

1. must not break the **test suite** (`npm test`), nor reduce **test coverage** (`npm run coverage`). If you're fixing a bug, include a test that would fail without your fix.
1. Must not break the **test suite** (`npm test`), nor reduce **test coverage** (`npm run coverage`). If you're fixing a bug, include a test that would fail without your fix.

1. must respect the **.eslintrc** (`npm run lint`). Ideally your editor supports `eslint`. Especially since the project is quite new, feel free to query default rules with us that don't make sense, or disable rules in a particular scope when it makes sense, together with a comment explaining why.
1. Must respect the **.eslintrc** (`npm run lint`). Ideally your editor supports `eslint`. Especially since the project is quite new, feel free to query default rules with us that don't make sense, or disable rules in a particular scope when it makes sense, together with a comment explaining why.

1. must update the **CHANGELOG.md** file, in the `Unreleased` section at the top, in the format of keepachangelog.com (**@mention** yourself at the end of the line).
1. Must update the **CHANGELOG.md** file, in the `Unreleased` section at the top, in the format of keepachangelog.com (**@mention** yourself at the end of the line).

1. must be **isolated**. Avoid grouping many, unrelated changes in a single PR.
1. Must be **isolated**. Avoid grouping many, unrelated changes in a single PR.

1. GitHub now allows auto-squashing of commits in a PR, so no need to rebase your commits before final submission.

### Submission

1. From "getting started", your work should ideally be in it's own feature branch.
1. `git push`, and click on the new "merge" button / row on the project page. *Merge to **devel***.
1. From [Getting Started](#getting-started), your work should ideally be in its own feature branch.
1. `git push` your branch to git and create a new pull request for the appropriate branch.

## Contributors with commit bit
## Contributors with Commit Bit

* Should still submit a PR for changes (i.e. no work should be done on `devel` directly; all work should be done in it's own separate feature branch), which should be okayed by one other team member before merging.
* Should still submit a PR for changes (i.e. no work should be done on a branch directly; all work should be done in it's own separate feature branch), which should be okayed by one other team member before merging.

* Should squash merged PRs whenever possible (via GitHub options).