summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLeo Famulari <leo@famulari.name>2023-03-05 14:54:06 -0500
committerLeo Famulari <leo@famulari.name>2023-03-05 14:58:56 -0500
commita66438e497303ce08d05cf8d76b2d5827e3e3578 (patch)
treefdea161e7cc56503d9b43d15b61d1127000c6c84 /doc
parentcedf97ed6ee4eba8c39bfe6cc0efe33fcb977ccf (diff)
doc: Give advice to contributors about communicating with reviewers.
* doc/contributing.texi (Submitting Patches): Give advice.
Diffstat (limited to 'doc')
-rw-r--r--doc/contributing.texi10
-rw-r--r--doc/guix.texi2
2 files changed, 11 insertions, 1 deletions
diff --git a/doc/contributing.texi b/doc/contributing.texi
index c436bc4a31..61c05c2489 100644
--- a/doc/contributing.texi
+++ b/doc/contributing.texi
@@ -1170,6 +1170,16 @@ Please write commit logs in the ChangeLog format (@pxref{Change Logs,,,
standards, GNU Coding Standards}); you can check the commit history for
examples.
+You can help make the review process more efficient, and increase the
+chance that your patch will be reviewed quickly, by describing the
+context of your patch and the impact you expect it to have. For
+example, if your patch is fixing something that is broken, describe the
+problem and how your patch fixes it. Tell us how you have tested your
+patch. Will users of the code changed by your patch have to adjust
+their workflow at all? If so, tell us how. In general, try to imagine
+what questions a reviewer will ask, and answer those questions in
+advance.
+
Before submitting a patch that adds or modifies a package definition,
please run through this check list:
diff --git a/doc/guix.texi b/doc/guix.texi
index 74658dbc86..7c6ff3d0c9 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -29,7 +29,7 @@ Copyright @copyright{} 2014, 2015, 2016 Alex Kost@*
Copyright @copyright{} 2015, 2016 Mathieu Lirzin@*
Copyright @copyright{} 2014 Pierre-Antoine Rault@*
Copyright @copyright{} 2015 Taylan Ulrich Bayırlı/Kammer@*
-Copyright @copyright{} 2015, 2016, 2017, 2019, 2020, 2021, 2023 Leo Famulari@*
+Copyright @copyright{} 2015, 2016, 2017, 2019, 2020, 2021, 2023, 2024 Leo Famulari@*
Copyright @copyright{} 2015, 2016, 2017, 2018, 2019, 2020, 2021, 2022, 2023 Ricardo Wurmus@*
Copyright @copyright{} 2016 Ben Woodcroft@*
Copyright @copyright{} 2016, 2017, 2018, 2021 Chris Marusich@*