| ... | ... | @@ -93,23 +93,23 @@ It is important to keep a commit history clean as it will help maintainers of th |
|
|
|
|
|
|
|
##### How to write a commit message ?
|
|
|
|
|
|
|
|
:warning: To help with the readability of the commit history, every git message MUST [follow the convention](https://www.conventionalcommits.org/en/v1.0.0/) :
|
|
|
|
:warning: To help with the readability of the commit history, every git message MUST [follow the convention](https://www.conventionalcommits.org/en/v1.0.0/) :
|
|
|
|
|
|
|
|
Either prefix your commit with :
|
|
|
|
Either prefix your commit with :
|
|
|
|
|
|
|
|
* `feat :` if its a new feature bringing something new to the other branches.
|
|
|
|
* `chore :` if it is something that doesn't impact the program, enhancing error message, filling a `README.md` ...
|
|
|
|
* `fix :` If you are fixing something that was broken IN OTHER BRANCHES.
|
|
|
|
* `chore :` if it is something that doesn't impact the program, enhancing error message, filling a `README.md` ...
|
|
|
|
* `fix :` If you are fixing something that was broken IN OTHER BRANCHES.
|
|
|
|
|
|
|
|
If you just created a new object in a branch, then you commit, and then realize the tests do not pass and create a fix commit about the feature you just implemented, you will need [to squash this commit with the previous feature commit](https://gitlab.eclipse.org/groups/eclipse/aidge/-/wikis/Get-good-at-git?edit=true#rebase) before merging your repo.
|
|
|
|
|
|
|
|
> **Example :**
|
|
|
|
> **Example :**
|
|
|
|
>
|
|
|
|
> ```text
|
|
|
|
> Chore : This is a commit message example. This line will serve as commit title.
|
|
|
|
> feat : Faster implementation of Foo function: improvement related to the branch feat/Optimization.
|
|
|
|
>
|
|
|
|
> The following Lines will be used to provide more context to someone that wants to inspect this given commit.
|
|
|
|
> Users are urged to provide as much context as possible in their commits.
|
|
|
|
> closes #xx (indicate that the issue fix the issue number xx)
|
|
|
|
> Note that for an issue located on another repository need to use the following format: repo_name#xx
|
|
|
|
> ```
|
|
|
|
|
|
|
|
##### What should a commit contain ?
|
| ... | ... | |