Difference between revisions of "Git style guide"

From Software Heritage Wiki
Jump to navigation Jump to search
(Created page with "Various information about how we use Git to develop Software Heritage. == Commits == Make your commits adhere to this [http://chris.beams.io/posts/git-commit/ ''How to W...")
 
(Use interwiki redirect)
Tag: New redirect
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
Various information about how we use Git to develop [[Software Heritage]].
+
#REDIRECT [[swhdocs:devel/contributing/git-style-guide.html]]
 
 
== 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:
 
<pre>
 
Closes T123456
 
</pre>
 
 
 
If you just want to "ping" a task, updating it with the fact that a related commit has been pushed, use:
 
<pre>
 
References T123456
 
</pre>
 
 
 
== References ==
 
 
 
* [https://secure.phabricator.com/T5132 special syntax you can use in commit messages to cause effects]
 
 
 
 
 
[[Category:Guidelines]]
 
[[Category:Software development]]
 

Latest revision as of 11:06, 22 March 2021