summary refs log tree commit diff stats
path: root/doc/contributing.rst
diff options
context:
space:
mode:
authorflywind <xzsflywind@gmail.com>2021-12-06 17:04:54 +0800
committerGitHub <noreply@github.com>2021-12-06 10:04:54 +0100
commitfaacd63bf69561fe915f3651e6b917bb2c0e5bc2 (patch)
tree646ab5324d6931d41ff7491cc530f8118fd1a62a /doc/contributing.rst
parente5475768ba5b540489fb47bdb6fdd338d75175e1 (diff)
downloadNim-faacd63bf69561fe915f3651e6b917bb2c0e5bc2.tar.gz
the title of PR should contain a brief description (#19211)
In addition to an issue number, the title of a PR should contain a brief description; then users can follow the progress more easily from the title.
Diffstat (limited to 'doc/contributing.rst')
-rw-r--r--doc/contributing.rst3
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/contributing.rst b/doc/contributing.rst
index 07fa01714..d3b2770f3 100644
--- a/doc/contributing.rst
+++ b/doc/contributing.rst
@@ -10,6 +10,9 @@ Contributing
 
 Contributing happens via "Pull requests" (PR) on github. Every PR needs to be
 reviewed before it can be merged and the Continuous Integration should be green.
+The title of a PR should contain a brief description. If it fixes an issue,
+in addition to the number of the issue, the title should also contain a description 
+of the issue.
 
 The PR has to be approved by two core developers or by Araq.