Skip to content

Contribution Guidelines

Bethany Armitage edited this page Aug 18, 2018 · 3 revisions

Contribution Guidelines

Contributors

  • Assign yourself to an issue you are or will shortly be actively working on

Branches

  • Branches are named as [feature/bug]/issue#-issue-title
  • One branch is created for one issue. Right now, there are only feature or bug issues.
  • Issue branches are always created from the master branch. Make sure you have the latest copy of master before checking out a feature branch from it.
git checkout master
git pull origin master
git checkout -b feature/3-issue-title

Commit Messages

  • Commits contain the issue reference, for example #42 this is a commit message. This way, the commit is referenced in the issue.

Pull Requests

  • One branch is created for one issue, so one pull request is also created for one issue.
  • Pull request must be approved for the branch to be merged
  • Make sure issue branch is updated with the latest of master and pointed at master
  • Before merging an approved pull request, make sure it is updated with the latest of master
git checkout master
git pull origin master
git checkout feature/3-issue-title
git merge master

Clone this wiki locally