Skip to content

Update Contributor Guides

Junio C Hamano git 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest6 patches 14 repliesIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/6SubmittingPatches: clarify expected structure of commit log messageDocumentation/SubmittingPatches+65 -758 replies
2/6MyFirstContribution: what if I don't get a reply?Documentation/MyFirstContribution.adoc+13 -02 replies
3/6MyFirstContribution: carrying over trailersDocumentation/MyFirstContribution.adoc+22 -00 replies
4/6MyFirstContribution: clarify that 'seen' does not mean acceptanceDocumentation/MyFirstContribution.adoc+14 -42 replies
5/6SubmittingPatches: clarify the meaning of "Will queue"Documentation/SubmittingPatches+3 -10 replies
6/6SubmittingPatches: clarify the writing style of whats-cookingDocumentation/SubmittingPatches+18 -92 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.

Read the v1 thread

Cover letter [PATCH 0/6] Update Contributor Guides

I have been tracking the rules I follow while updating the "What's cooking" draft, which guides my daily work, and noticed a few gaps in our contributor documentation.

* We often tell contributors how commit log messages should look on the mailing list, but the language in SubmittingPatches is too wordy. The first patch in this series shortens it to get to the point earlier.

* We recently updated MyFirstContribution to advise contributors to pace themselves when they find mistakes or receive feedback. However, we lack instructions for when a patch receives no reaction. The second patch addresses this gap.

* There seems to be some confusion regarding when contributors should add Reviewed-by: and Acked-by: trailers. The third patch clarifies this process.

* We want to ensure contributors don't walk away once their patch lands in seen, as that is merely the beginning of the story. The fourth and fifth patches clarify this point.

* An experimental feature in SubmittingPatches invites contributors to draft the description for their topic in the "What's cooking" report. However, instead of outlining the expected tone, we simply told them to emulate existing entries. The final patch remedies this.

1/6: SubmittingPatches: clarify expected structure of commit log message 2/6: MyFirstContribution: what if I don't get a reply?
3/6: MyFirstContribution: carrying over trailers
4/6: MyFirstContribution: clarify that 'seen' does not mean acceptance 5/6: SubmittingPatches: clarify the meaning of "Will queue" 6/6: SubmittingPatches: clarify the writing style of whats-cooking

 Documentation/MyFirstContribution.adoc |  53 +++++++-
 Documentation/SubmittingPatches        | 171 +++++++++++++------------
 2 files changed, 135 insertions(+), 89 deletions(-)
Signature · 1 line
2.55.0-391-gdf86bf5712