Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: Add section about mentioning others to commit discipline doc.

This commit is contained in:
Alya Abbott 2023-05-25 13:57:21 -05:00 committed by Tim Abbott
parent 38c8c374d5
commit 660ccccf68
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/contributing/commit-discipline.md
View File

@ -279,6 +279,23 @@ might worry about it breaking.
you developed this commit or pull request, like "First I tried X" or
"I changed Y".
#### Mentioning other contributors
You can
[credit](https://docs.github.com/en/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors)
co-authors on a commit by adding a `Co-authored-by:` line after a blank line at
the end of your commit message:
Co-authored-by: Greg Price <greg@zulip.com>
You can also add other notes, such as `Reported-by:`, `Debugged-by:`, or
`Suggested-by:`, but we don't typically do so.
**Never @-mention a contributor in a commit message**, as GitHub will turn this into
a notification for the person every time a version of the commit is rebased and
pushed somewhere. If you want to send someone a notification about a change,
@-mention them in the PR thread.
#### Formatting guidelines
There are a few specific formatting guidelines to keep in mind: