diff mbox series

[1/2] docs: README: specify how to contribute instead of pointing at another file

Message ID 20250605-readme-contrib-v1-1-c51b8cc57b7a@cherry.de
State Accepted
Headers show
Series README: fix contribution instructions when included in poky | expand

Commit Message

Quentin Schulz June 5, 2025, 2:10 p.m. UTC 
From: Quentin Schulz <quentin.schulz@cherry.de>

This repository is partially included in another repository: poky.

However its README isn't making it, so documentation/README pointing at
the README at the root of the git repository would lead the contributor
nowhere.

Instead, let's include the appropriate information directly in
documentation/README which does make it to the poky git repo.

Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
---
 documentation/README | 21 +++++++++++++++++++--
 1 file changed, 19 insertions(+), 2 deletions(-)
diff mbox series

Patch

diff --git a/documentation/README b/documentation/README
index 8a47fd4a3fd07d41d61a7d681d82bd13ac74527d..02037e0f7ecf5c7ea18688e8ffbcfbd60c859f1c 100644
--- a/documentation/README
+++ b/documentation/README
@@ -406,5 +406,22 @@  both the Yocto Project and BitBake manuals:
 Submitting documentation changes
 ================================
 
-Please see the top level README file in this repository for details of where
-to send patches.
+Please refer to our contributor guide here: https://docs.yoctoproject.org/contributor-guide/
+for full details on how to submit changes.
+
+As a quick guide, patches should be sent to docs@lists.yoctoproject.org
+The git command to do that would be:
+
+     git send-email -M -1 --to docs@lists.yoctoproject.org
+
+The 'To' header can be set as default for this repository:
+
+     git config sendemail.to docs@lists.yoctoproject.org
+
+Now you can just do 'git send-email origin/master..' to send all local patches.
+
+Read the other sections in this document and documentation/standards.md for
+rules to follow when contributing to the documentation.
+
+Git repository: https://git.yoctoproject.org/yocto-docs
+Mailing list: docs@lists.yoctoproject.org