Difference between revisions of "Git style guide"

From Software Heritage Wiki
Jump to: navigation, search
m (Link commits to tasks)
(move to the main doc)
Line 1: Line 1:
Various information about how we use Git to develop [[Software Heritage]].
This page was [https://docs.softwareheritage.org/devel/contributing/git-style-guide.html moved to the main development documentation]
== Commits ==
Make your commits adhere to this [http://chris.beams.io/posts/git-commit/ ''How to Write a Git Commit Message''] tutorial.
== Link commits to tasks ==
You can reference [[Phabricator]] tasks from your commits, using a [https://secure.phabricator.com/T5132 dedicated syntax].
When you do so, please put the task action on a separate line, so that it is clearly visible.
Make sure commits that are enough to close a bug do so using a line like:
Closes T123456
If you just want to "ping" a task, updating it with the fact that a related commit has been pushed, use:
Related to T123456
== References ==
* [https://secure.phabricator.com/T5132 special syntax you can use in commit messages to cause effects]
[[Category:Software development]]
[[Category:Software development]]

Revision as of 09:01, 18 March 2021