Good practices before commiting#

Before commiting, please follow the following guidelines:

Before#

  • Check that your code runs without error.

  • Check that your code is clean: follows PEP8 conventions, does not produce debugging outputs, and does not contain commented lines.

Content#

  • A commit should be as atomic as possible: 1 task/1 bug fix = 1 commit.

  • A commit must always contain a message explaining the reason and/or the content of the commit.

Message#

To improve readability, commit messages should follow this template:

<context>(<scope>) - #<issue_number> Summary title

- List of task or bugfix done in this commit
- Each item must start with a markdown bullet character like `-`

  • <context>:

    • fix for bug fix

    • feature for development about a new feature

    • doc for adding documentation

    • refactor for improvement of readability, reusability or structure

  • <scope> is the feature or field involved by this commit (optionnal)

  • <issue_number> refer to GitHub issues (optionnal)

Example:

doc(contributor) - #167 Write file for commit good practices

- Before check-list
- Content reminder
- Message template
- This example