diff mbox series

[mickledore] README: Update to point to new contributor guide

Message ID 20230907093359.197435-1-michael.opdenacker@bootlin.com
State New
Headers show
Series [mickledore] README: Update to point to new contributor guide | expand

Commit Message

Michael Opdenacker Sept. 7, 2023, 9:33 a.m. UTC
From: Michael Opdenacker <michael.opdenacker@bootlin.com>

From: Richard Purdie <richard.purdie@linuxfoundation.org>

Now we have a contributor guide combining various wiki pages, point at
that and tweak to match our other READMEs.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
 README | 19 +++++++++----------
 1 file changed, 9 insertions(+), 10 deletions(-)
diff mbox series

Patch

diff --git a/README b/README
index 85d8d837b2..88d7fc5530 100644
--- a/README
+++ b/README
@@ -10,23 +10,22 @@  An online version of the documentation can be found at:
 Contributing
 ============
 
-See https://www.openembedded.org/wiki/How_to_submit_a_patch_to_OpenEmbedded
-for generic guidelines for configuring Git and preparing patches.
+Please refer to our contributor guide here: https://docs.yoctoproject.org/contributor-guide/
+for full details on how to submit changes.
 
-Read the documentation/README and documentation/standards.md files
-for rules to follow when contributing to the documentation.
-
-Where to Send Patches
-=====================
+As a quick guide, patches should be sent to docs@lists.yoctoproject.org
+The git command to do that would be:
 
-When sending single patches, please using something like:
-'git send-email -1 --to docs@lists.yoctoproject.org
+     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
+     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 documentation/README and documentation/standards.md files
+for rules to follow when contributing to the documentation.
+
 Git repository: https://git.yoctoproject.org/yocto-docs
 Mailing list: docs@lists.yoctoproject.org