tyiu/damus
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: clarify the section on using -v2,v3, etc

Browse Source 
Some patches are still not getting sent with version information. Let's
clarify that in the contribution docs.

Cc: dev@damus.io
This commit is contained in:
William Casarin
2023-07-16 10:05:15 -07:00
parent f53b824122
commit da78a217a3
1 changed files with 8 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/CONTRIBUTING.md
View File

@@ -49,13 +49,14 @@ the dedicated `Separate your changes` section because this is very
important. important.
When you submit or resubmit a patch or patch series, include the complete When you submit or resubmit a patch or patch series, include the complete
patch description and justification for it (-v2,v3,vn... option on patch description and justification for it. Each new version should use
git-send-email). Don't just say that this is version N of the patch the -v2,v3,vN option on git-send-email for each new patch revision. Don't
(series). Don't expect the reviewer to refer back to earlier patch just say that this is version N of the patch (series). Don't expect the
versions or referenced URLs to find the patch description and put that reviewer to refer back to earlier patch versions or referenced URLs to
into the patch. I.e., the patch (series) and its description should be find the patch description and put that into the patch. I.e., the patch
self-contained. This benefits both the maintainers and reviewers. Some (series) and its description should be self-contained. This benefits both
reviewers probably didn't even receive earlier versions of the patch. 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" Describe your changes in imperative mood, e.g. "make xyzzy do frotz"
instead of "[This patch] makes xyzzy do frotz" or "[I] changed xyzzy instead of "[This patch] makes xyzzy do frotz" or "[I] changed xyzzy