commit f53b8241222675da3972dfb7d2625eef2c02652a parent 45ab394b09a958e2f89bde17bd24e8364b81c453 Author: William Casarin <jb55@jb55.com> Date: Sun, 16 Jul 2023 09:44:27 -0700 docs: patch changelogs when submitting patches This adds a section on creating patch changelogs when submitting patches. It helps reviewers know what changed between many different versions of a patch Diffstat:
| M | docs/CONTRIBUTING.md | | | 18 | ++++++++++++++++++ |
1 file changed, 18 insertions(+), 0 deletions(-)
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md @@ -125,6 +125,24 @@ you introduce bugs in the middle. If you cannot condense your patch set into a smaller set of patches, then only post say 15 or so at a time and wait for review and integration. +Include `patch changelogs` which describe what has changed between the v1 and +v2 version of the patch. Please put this information **after** the `---` line +which separates the changelog from the rest of the patch. The version +information is not part of the changelog which gets committed to the git tree. +It is additional information for the reviewers. If it's placed above the commit +tags, it needs manual interaction to remove it. If it is below the separator +line, it gets automatically stripped off when applying the patch:: + + <commit message> + ... + Signed-off-by: Author <author@mail> + --- + V2 -> V3: Removed redundant helper function + V1 -> V2: Cleaned up coding style and addressed review comments + + path/to/file | 5+++-- + ... + ### Select the recipients for your patch