mbox series

[0/7] contributor-guide: submit-changes: improve instructions on commit content

Message ID 20250918-submit-patches-v1-0-28abd2919df0@cherry.de
Headers show
Series contributor-guide: submit-changes: improve instructions on commit content | expand

Message

Quentin Schulz Sept. 18, 2025, 10:24 a.m. UTC
This hopefully improves instructions on how to write a proper commit for
submitting to the Yocto Project/OpenEmbedded various projects.

This was prompted by some new contributor following the instructions and
coming up with something different than what we had in mind.

Then I got carried away and fixed/improved a few other things in this
document.

This is opinionated from someone who's used to deal with mail-based
contribution so please feel free to nitpick/do bikeshedding/suggest
something else even more than usual.

Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
---
Quentin Schulz (7):
      contributor-guide: submit-changes: fix improper bold string
      contributor-guide: submit-changes: clarify example with Yocto bug ID
      contributor-guide: submit-changes: align CC tag description
      contributor-guide: submit-changes: make the Cc tag follow kernel guidelines
      contributor-guide: submit-changes: reword commit message instructions
      contributor-guide: submit-changes: number instruction list in commit your changes
      contributor-guide: submit-changes: make "Crediting contributors" part of "Commit your changes"

 documentation/contributor-guide/submit-changes.rst | 186 +++++++++++----------
 1 file changed, 96 insertions(+), 90 deletions(-)
---
base-commit: e77139b5c616e6e5ad436eb91416fd804389425f
change-id: 20250918-submit-patches-4c2733a3d56d

Best regards,

Comments

Antonin Godard Sept. 29, 2025, 6:44 a.m. UTC | #1
On Thu, 18 Sep 2025 12:24:38 +0200, Quentin Schulz wrote:
> This hopefully improves instructions on how to write a proper commit for
> submitting to the Yocto Project/OpenEmbedded various projects.
> 
> This was prompted by some new contributor following the instructions and
> coming up with something different than what we had in mind.
> 
> Then I got carried away and fixed/improved a few other things in this
> document.
> 
> [...]

Applied, thanks!

[1/7] contributor-guide: submit-changes: fix improper bold string
      commit: 6c499b3796a578a0fe4c319c9547b4321b0d41df
[2/7] contributor-guide: submit-changes: clarify example with Yocto bug ID
      commit: a5862406bf3230befe9db9f2539bbbc86c02015d
[3/7] contributor-guide: submit-changes: align CC tag description
      commit: f116e93fb335e9d0f85891c4cb501bcf55b18ccf
[4/7] contributor-guide: submit-changes: make the Cc tag follow kernel guidelines
      commit: f800fef4e9e2c1d3584ac49be8324638d2923b17
[5/7] contributor-guide: submit-changes: reword commit message instructions
      commit: b84903a760350bd118c56ea9ce4e98039edf6e55
[6/7] contributor-guide: submit-changes: number instruction list in commit your changes
      commit: c628a489f081925fabaabb5acac6752251150269
[7/7] contributor-guide: submit-changes: make "Crediting contributors" part of "Commit your changes"
      commit: eff4d14e28d323ebfdaeb0c5c805b5f1e2ad153d

Best regards,