diff --git a/docs/contributing/git-style-guide.rst b/docs/contributing/git-style-guide.rst new file mode 100644 index 0000000000000000000000000000000000000000..3fcac1f537032e0d4565cc3d8eeb7eda47da6872 --- /dev/null +++ b/docs/contributing/git-style-guide.rst @@ -0,0 +1,33 @@ +.. _git-style-guide: + +Git style guide +=============== + +Various information about how we use Git to develop Software Heritage. + +Commits +------- + +Make your commits adhere to this `How to Write a Git Commit Message <http://chris.beams.io/posts/git-commit/>`_ + +Link commits to tasks ++++++++++++++++++++++ + +You can reference Phabricator tasks from your commits, +using a `dedicated syntax <https://secure.phabricator.com/T5132>`_ +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 +---------- + +* `special syntax you can use in commit messages to cause effects <https://secure.phabricator.com/T5132>`_ diff --git a/docs/contributing/index.rst b/docs/contributing/index.rst index e0475bec4e97f864eb9f73b474fbc4142030ae21..e3d9ec6964ecad8d706f54740148adbb16471949 100644 --- a/docs/contributing/index.rst +++ b/docs/contributing/index.rst @@ -10,4 +10,5 @@ Contributing phabricator code-review python-style-guide + git-style-guide sphinx