Skip to content

Development practices

Jump to bottom
Alix Peigue edited this page Feb 6, 2025 · 5 revisions

List of the development practices to follow in this project

GitHub issue

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

Branch name

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

Pull Request

Create a pull request for the branch that you created. The title 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

The body should be a more thorough description. Always add Closes #<issue-number> at the end of the PR body.

Merging

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.

Clone this wiki locally