From 6214c264631bad36ced87e5aacec6ee100f7bbf1 Mon Sep 17 00:00:00 2001 From: Vijith Assar Date: Thu, 22 Jun 2023 15:09:13 -0400 Subject: [PATCH] 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. --- CONTRIBUTING.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ef159888adf5..fbcbcd09edf3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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