Skip to content

Latest commit

 

History

History
24 lines (15 loc) · 1.06 KB

CONTRIBUTING.md

File metadata and controls

24 lines (15 loc) · 1.06 KB
Raw

CONTRIBUTING

Method of adding changes

Changes will be added via branching:

  • Create a new branch with a descriptive name, followed by _ and initials, (for example: contributing_AG).
  • Make all changes in this branch, and commit and push your changes.
  • When the branch is ready to merge, open a pull request for the merge, tagging the other two contributors.
  • Once this issue is raised STOP working in this branch until the issue is resolved.
  • Either of the other contributors has full authority to merge changes.
  • When a branch is merged in with the Master, that branch should be immediately deleted.

Raising Issues

Please raise an issue for any and all things! As a courtesy, please tag all of the contributors.

Commit Messages

Remember that commit messages are the way to remember what was done, and keep messages meaningful.

Directory Structure

Keep all documents in the correct folder, when in doubt, ask the other contributors (perhaps in an issue?). Remember to cite any sources in the doc\references\README.md, which documents any citations.