-
Notifications
You must be signed in to change notification settings - Fork 0
Development practices
First step is always to create a GitHub issue, with a clear title and a body that explains precisely what is the bug or the feature described
When creating a branch to solve an issue, use the naming convention <issue number>-description-of-the-change. So for example : #18-presist-test-results
The message of the first commit should start with Feat: or Fix: or Doc: or Refactor: , then the issue number then a very brief description. So for example: Feat: #18 add functionality to persist test results on disk
Create a pull request for the branch that you created. The title should be the same as the message of the first commit of the branch.
The body should be a more thorough description. Always add Closes #<issue-number> at the end of the PR body.
Merging should always be done by squash and merge. The use of any other merge method if squash is somehow not the best strategy for a PR should be discussed in the PR.