2. How to contribute - Ray-F/youth-elections GitHub Wiki

Commit message should be...

Storycode format: [YEL-###]

When starting a story, make a feature branch from master, with naming convention STORYCODE/short-description-of-story.

Commits

Format commits as follows...

[STORYCODE] Commit Heading

  • Issue: (what needed to be done)
  • Solution: (what you did)
  • Risk area: (if there's any chance it could conflict with existing or future changes)

Reviewers should be able to understand the purpose and intent of each commit, and each commit should be made with only one change in mind. If you made multiple changes in one coding session, you can commit each 'changed' feature separately in hunks, or even line by line.

Pull requests

Pull requests should also contain field:

  • Reviewed by: (who to review your code)

Make sure to select 'squash and merge' when finalising a pull request to keep master commit history clean.