Skip to content
Matt Harris edited this page May 13, 2015 · 3 revisions

Please use these general norms when interacting with this repository.

Generally, the approach described here is based on the GitHub Flow (5 minute read). If you're unsure of how to contribute, please ask!

The master branch

The master branch is the current, latest, clean branch. SIF Association staff controls this branch and they are the only ones who should merge in to this branch. This ensures that master is always the “closest to publication” version.

Tags

Tags are used to lock in snapshots for various releases, such as v3.3 or v3.3-review or v3.3-review.2.

Working/development branches and pull requests

Individual work groups or developers create feature branches using the naming convention feature/my-feature-name. If the branch implements a bug fix, developers can choose to use a name like bugfix/my-bugfix-name. Changes should be made in those feature branches, and when features are ready for discussion or possible inclusion into master, developers should create a pull request with the changes. Discussion can occur within the pull request directly, and changes can be made until agreement is reached on the changes. When ready, a SIF staff member merges the pull request into the master branch.

Forks

Members who are not a part of the core development team should fork the repository and make changes in their own local copy. When ready to submit a proposed change, create a pull request to submit your changes back in to the main repository. The process of pull request review proceeds as above.

Questions

If you have questions, contact John Lovell.

Clone this wiki locally