me
/
guix
Archived
1
0
Fork 0
Code

doc: Give advice to contributors about communicating with reviewers. 

* doc/contributing.texi (Submitting Patches): Give advice.
master
Leo Famulari 2023-03-05 14:54:06 -05:00
parent cedf97ed6e
commit a66438e497
No known key found for this signature in database
GPG Key ID: 2646FA30BACA7F08
2 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/contributing.texi
View File

@ -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:

2
doc/guix.texi
View File

@ -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@*