diff options
| author | Leo Famulari <leo@famulari.name> | 2023-03-05 14:54:06 -0500 |
|---|---|---|
| committer | Leo Famulari <leo@famulari.name> | 2023-03-05 14:58:56 -0500 |
| commit | a66438e497303ce08d05cf8d76b2d5827e3e3578 (patch) | |
| tree | fdea161e7cc56503d9b43d15b61d1127000c6c84 | |
| parent | cedf97ed6ee4eba8c39bfe6cc0efe33fcb977ccf (diff) | |
doc: Give advice to contributors about communicating with reviewers.
* doc/contributing.texi (Submitting Patches): Give advice.
| -rw-r--r-- | doc/contributing.texi | 10 | ||||
| -rw-r--r-- | doc/guix.texi | 2 |
2 files changed, 11 insertions, 1 deletions
diff --git a/doc/contributing.texi b/doc/contributing.texi index c436bc4a31f..61c05c24895 100644 --- a/doc/contributing.texi +++ b/doc/contributing.texi | |||
| @@ -1170,6 +1170,16 @@ Please write commit logs in the ChangeLog format (@pxref{Change Logs,,, | |||
| 1170 | standards, GNU Coding Standards}); you can check the commit history for | 1170 | standards, GNU Coding Standards}); you can check the commit history for |
| 1171 | examples. | 1171 | examples. |
| 1172 | 1172 | ||
| 1173 | You can help make the review process more efficient, and increase the | ||
| 1174 | chance that your patch will be reviewed quickly, by describing the | ||
| 1175 | context of your patch and the impact you expect it to have. For | ||
| 1176 | example, if your patch is fixing something that is broken, describe the | ||
| 1177 | problem and how your patch fixes it. Tell us how you have tested your | ||
| 1178 | patch. Will users of the code changed by your patch have to adjust | ||
| 1179 | their workflow at all? If so, tell us how. In general, try to imagine | ||
| 1180 | what questions a reviewer will ask, and answer those questions in | ||
| 1181 | advance. | ||
| 1182 | |||
| 1173 | Before submitting a patch that adds or modifies a package definition, | 1183 | Before submitting a patch that adds or modifies a package definition, |
| 1174 | please run through this check list: | 1184 | please run through this check list: |
| 1175 | 1185 | ||
diff --git a/doc/guix.texi b/doc/guix.texi index 74658dbc866..7c6ff3d0c9b 100644 --- a/doc/guix.texi +++ b/doc/guix.texi | |||
| @@ -29,7 +29,7 @@ Copyright @copyright{} 2014, 2015, 2016 Alex Kost@* | |||
| 29 | Copyright @copyright{} 2015, 2016 Mathieu Lirzin@* | 29 | Copyright @copyright{} 2015, 2016 Mathieu Lirzin@* |
| 30 | Copyright @copyright{} 2014 Pierre-Antoine Rault@* | 30 | Copyright @copyright{} 2014 Pierre-Antoine Rault@* |
| 31 | Copyright @copyright{} 2015 Taylan Ulrich Bayırlı/Kammer@* | 31 | Copyright @copyright{} 2015 Taylan Ulrich Bayırlı/Kammer@* |
| 32 | Copyright @copyright{} 2015, 2016, 2017, 2019, 2020, 2021, 2023 Leo Famulari@* | 32 | Copyright @copyright{} 2015, 2016, 2017, 2019, 2020, 2021, 2023, 2024 Leo Famulari@* |
| 33 | Copyright @copyright{} 2015, 2016, 2017, 2018, 2019, 2020, 2021, 2022, 2023 Ricardo Wurmus@* | 33 | Copyright @copyright{} 2015, 2016, 2017, 2018, 2019, 2020, 2021, 2022, 2023 Ricardo Wurmus@* |
| 34 | Copyright @copyright{} 2016 Ben Woodcroft@* | 34 | Copyright @copyright{} 2016 Ben Woodcroft@* |
| 35 | Copyright @copyright{} 2016, 2017, 2018, 2021 Chris Marusich@* | 35 | Copyright @copyright{} 2016, 2017, 2018, 2021 Chris Marusich@* |
