commit da78a217a337236340e0911052863684b0c2568d
parent f53b8241222675da3972dfb7d2625eef2c02652a
Author: William Casarin <jb55@jb55.com>
Date: Sun, 16 Jul 2023 10:05:15 -0700
docs: clarify the section on using -v2,v3, etc
Some patches are still not getting sent with version information. Let's
clarify that in the contribution docs.
Cc: dev@damus.io
Diffstat:
1 file changed, 8 insertions(+), 7 deletions(-)
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
@@ -49,13 +49,14 @@ the dedicated `Separate your changes` section because this is very
important.
When you submit or resubmit a patch or patch series, include the complete
-patch description and justification for it (-v2,v3,vn... option on
-git-send-email). Don't just say that this is version N of the patch
-(series). Don't expect the reviewer to refer back to earlier patch
-versions or referenced URLs to find the patch description and put that
-into the patch. I.e., the patch (series) and its description should be
-self-contained. This benefits both the maintainers and reviewers. Some
-reviewers probably didn't even receive earlier versions of the patch.
+patch description and justification for it. Each new version should use
+the -v2,v3,vN option on git-send-email for each new patch revision. Don't
+just say that this is version N of the patch (series). Don't expect the
+reviewer to refer back to earlier patch versions or referenced URLs to
+find the patch description and put that into the patch. I.e., the patch
+(series) and its description should be self-contained. This benefits both
+the maintainers and reviewers. Some reviewers probably didn't even
+receive earlier versions of the patch.
Describe your changes in imperative mood, e.g. "make xyzzy do frotz"
instead of "[This patch] makes xyzzy do frotz" or "[I] changed xyzzy
