-
Notifications
You must be signed in to change notification settings - Fork 42
Pull request guidelines
Casey Wong edited this page Mar 8, 2020
·
11 revisions
Important: Do not merge your own pull request, one of the reviewers should will merge it
The pull request is complete according to the following criteria:
- Acceptance criteria have been met
- The documentation is kept up-to-date
- Comprehensive tests (if applicable) have been generated and all pass.
- The pull request describes the changes that have been made, and enough information is present in the description for any developer to understand what has changed
- Commmits have been squashed
- The pull request title is of the following format : {issue/bug...}/(Issue Number) - Name of issue. E.g bug/30-Fix-Project
- The description uses github syntax to link to the issue. E,g Resolves se701g2/Doto#4
Code Review Guidelines: The general guidelines are as follows:
- Check all unit tests are passed (unit-tests, integration tests etc).
- Check/Clean the commenting, spelling and TODO's
- If you make a change need to explain what it was and why the change needs to be made
- Also dont forget to review your own code! See Code Review Checklist for more details
- At least two reviewers assigned. One of which must be the assigner of the issue.
- If there are merge conflicts, run git rebase as opposed to git merge with master.