Skip to content

Latest commit

 

History

History
19 lines (17 loc) · 1.31 KB

CONTRIBUTING.md

File metadata and controls

19 lines (17 loc) · 1.31 KB
Raw

Contributing

General Workflow

  1. Read the git flow branching model
  2. If you do not have collaborator access, fork the repo
  3. Cut a namespaced branch
  4. Feature branches are cut from develop - feature-<name>-#<issueNumber>
  5. Hotfix branches are cut from master - hotfix-<name>
  6. Make commits to your feature branch. Commits are written in present tense.
  7. When you've finished with your fix or feature, Rebase upstream changes into your branch.
  8. Follow directions in the Git Flow wiki page.
  9. Submit a pull request to the branch from which yours was cut (i.e. master for hotfix, or develop for feature. Include a description of your changes.
  10. In most cases, your branch should not break TODO: the build. You can run build tests on your local machine with npm test. If your branch does not pass specs, explain why in your pull request.
  11. Your pull request will be reviewed by another maintainer.
  12. Fix any issues raised by your code reviwer, and push your fixes as a single new commit.
  13. Once the pull request has been reviewed, it will be merged by the Scrum Master. The Scrum Master may choose to delegate review and merging of pull requests to other collaborators.