These rules and guides are written with git (a decentralised SCC system) in mind:
- commit
= add changes to local repository
- push
= sync changes with remote (central) repository
Meaningful branch names
_
) -
)_
) 106_module-names-in-ui_mse
update-hse-libs_jha
develop
branch without integration testingMeaningful commit messages
Mentioning other resources like issues in commit messages will make it easier to map commits on the git history with other tools like issue trackers etc. Depending on the tool used, it will allow for jumping from one item to another (like clicking on the issue number in a commit message and jumping to the issue description).
Issue
Add the string (issue #<number>)
to the commit message
this is some message (issue #45)
Merge Request
Add the string (MR !<number>)
to the commit message
another message (MR !7)
WIP: definition of rules to be used for automatically generating useful release notes
lvdiff
(and lvmerge
) for your git client