| ... | ... | @@ -103,10 +103,10 @@ Either prefix your commit with : |
|
|
|
|
|
|
|
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 :**
|
|
|
|
> :bulb: **Example :**
|
|
|
|
>
|
|
|
|
> ```text
|
|
|
|
> feat : Faster implementation of Foo function: improvement related to the branch feat/Optimization.
|
|
|
|
> fix : Faster implementation of Foo function: improvement related to the branch feat/Optimization.
|
|
|
|
>
|
|
|
|
> 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
|
| ... | ... | @@ -122,17 +122,11 @@ A commit should be atomic, meaning that 1 commit must contains changes that : |
|
|
|
2. Can be grouped under 1 common designations (the commit message).
|
|
|
|
3. This designation is the shortest common denominator.
|
|
|
|
|
|
|
|
> **🧠 Example :** You created a branch to add the opeator `Foo` in aidge_core. While working, you discovered an issue in another file that is not related to the `Foo` operator, and completed the README with a new . This will result in 2 commits that will be written following the commits conventions explained above :
|
|
|
|
> :bulb: **Example :** You created a branch to add the opeator `Foo` in aidge_core. While working, you discovered an issue in another file that is not related to the `Foo` operator, and completed the README with a new . This will result in 3 commits that will be written following the commits conventions explained above :
|
|
|
|
>
|
|
|
|
> 1. `feat : adding support of operator Foo` that will contain all modifications related to foo, it can (and should) cover multiple files.
|
|
|
|
> 1. `feat : adding support of operator Foo`
|
|
|
|
> 2. `chore: completed README.MD with missing informations about ....`
|
|
|
|
> 3. Note That this is multi line commit as shown just above
|
|
|
|
>
|
|
|
|
> ```
|
|
|
|
> fix: Added assertion to avoid buffer Overflow in Bar::baz(n)
|
|
|
|
>
|
|
|
|
> previously, when n was above `int8` limit Bar::baz(n) could overflow, An assertion was added to avoid that and provide a more meaningful error message."
|
|
|
|
> ```
|
|
|
|
> 3. `fix: Added assertion to avoid buffer Overflow in Bar::baz(n)`
|
|
|
|
|
|
|
|
## diff
|
|
|
|
|
| ... | ... | |