Skip to content

Guidelines

Jjampong edited this page Mar 9, 2021 · 16 revisions

Coding Guidelines

GitHub Guidelines

Branching Rules

  • For each userstory each user is allowed to make their own branch. The user branch should be directly based on dev and has the following format: <UserstoryNr>_<User>.
  • Aside from user branches. Hotfix branches based on dev are also allowed.
  • Main is updated once per sprint. (Every 2 weeks)

Review Rules

  • 4 reviews are required to merge from dev into main.
  • 2 reviews are required from any branch into dev. (Excluding the code owner's review)
  • Reviews should come with useful feedback. Not just criticism.
  • Use the Code Highlight tool.
  • Merge conflicts should be solved by the merge request's owner.
  • Draft merge requests don't have to be reviewed. If it is a draft be sure to mark it with the WIP label.
  • The merge request owner is responsible for the assigning reviewers.

Issue Rules

  • Use the issues for bugs, glitches and thrown errors.
  • An issue should include how to reproduce the issue.
  • An issue should include the expected result and current result.
  • If a pull request solves an issue, connect it to the issue.

Clone this wiki locally