|
|
|
**Page author :** @gregkub
|
|
|
|
|
|
|
|
Git is a versionning tool allowing multiple programmers to work simultaneously on the same codebase. Remember one day as a programmer you will have issues with git, wether you want it or not. So you better get good at it.
|
|
|
|
|
|
|
|
Once you have learnt how these commands work I strongly advise you to use a git tui (Terminal user Interface) such as [gitui](https://github.com/extrawurst/gitui), lazygit or vscode. This will help you curate your commits to have meaningful commits.
|
| ... | ... | @@ -122,11 +124,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.
|
|
|
|
|
|
|
|
> :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 :
|
|
|
|
> :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`
|
|
|
|
> 1. `feat : adding support of operator Foo`
|
|
|
|
> 2. `chore: completed README.MD with missing informations about ....`
|
|
|
|
> 3. `fix: Added assertion to avoid buffer Overflow in Bar::baz(n)`
|
|
|
|
> 3. `fix: Added assertion to avoid buffer Overflow in Bar::baz(n)`
|
|
|
|
|
|
|
|
## diff
|
|
|
|
|
| ... | ... | |