-
-
Notifications
You must be signed in to change notification settings - Fork 18
How to Contribute
It's really awesome to have so many people contributing code. We're excited for what you're helping us to build! Because there are so many people working to contribute, and because this can get hectic quickly, here are a few guidelines:
We operate on a pull request model. This allows other team members to view your code before it's merged to master
, and for members of the team with context to offer feedback and ask technical questions. If you're brand new to pull requests within GitHub, their help documentation on pull requests is pretty excellent.
If you're planning on being a somewhat regular contributor, we ask you that you:
- use feature branches for your pull requests instead of using the master branch of your fork. Every time you want to create a new feature, create a new branch for that feature; when that feature is finished and has been merged, delete that branch. This is to make it easier to keep your master branch in sync, and so that you're not blocked from developing further while others review your pull request.
- keep your fork in sync with the main repository by adding it as an upstream remote and then merging the upstream code into your fork.
If you've already started a feature branch, but you need some changes from master
that were added after you started, you can rebase your feature branch to pull those changes in while avoiding merge commits, which can be confusing to reviewers of your pull request.