link to GitHub Issues from CONTRIBUTING.md
Include a link to the pool of GitHub Issues in the instructions to make it easier for new contributors to look up relevant Issues when they encounter the commit message requirements for the first time.
This commit is contained in:
parent
c2b1d76e6d
commit
6214c26463
1 changed files with 4 additions and 3 deletions
|
@ -205,10 +205,11 @@ So you wanna make a pull request? Please observe the following guidelines.
|
|||
to aid in the review process.
|
||||
- Provide a well written and nicely formatted commit message. See [this
|
||||
link](http://chris.beams.io/posts/git-commit/)
|
||||
for some tips on formatting. As far as content, try to include in your
|
||||
summary
|
||||
for some tips on formatting. As far as content, try to include the following in your
|
||||
summary:
|
||||
|
||||
1. What you changed
|
||||
2. Why this change was made (including git issue # if appropriate)
|
||||
2. Why this change was made. If there is a relevant [GitHub Issue](https://github.com/signalapp/Signal-Desktop/issues), please include the Issue number.
|
||||
3. Any relevant technical details or motivations for your implementation
|
||||
choices that may be helpful to someone reviewing or auditing the commit
|
||||
history in the future. When in doubt, err on the side of a longer
|
||||
|
|
Loading…
Reference in a new issue