diff mbox series

docs: README: improve contribution guidelines

Message ID 20220629085620.3362348-1-michael.opdenacker@bootlin.com
State New
Headers show
Series docs: README: improve contribution guidelines | expand

Commit Message

Michael Opdenacker June 29, 2022, 8:56 a.m. UTC 
From: Michael Opdenacker <michael.opdenacker@bootlin.com>

Properly refer to the guidelines for configuring git
and preparing patches, plus minor improvements and updates.

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
 README | 13 ++++++++-----
 1 file changed, 8 insertions(+), 5 deletions(-)
diff mbox series

Patch

diff --git a/README b/README
index 4f95342042..31119905e7 100644
--- a/README
+++ b/README
@@ -2,7 +2,7 @@  Yocto Project Documentation
 ===========================
 
 This repository contains documentation materials for a variety of the Yocto
-Project components. In particular see the README under documentation/.
+Project components. In particular see the README file under documentation/.
 
 An online version of the documentation can be found at:
     https://docs.yoctoproject.org
@@ -10,8 +10,11 @@  An online version of the documentation can be found at:
 Contributing
 ============
 
-Read the documentation/standards.md file which specifies some rules
-to follow when contributing to the documentation.
+See https://www.openembedded.org/wiki/How_to_submit_a_patch_to_OpenEmbedded
+for generic guidelines for configuring Git and preparing patches.
+
+Read the documentation/README and documentation/standards.md files
+for rules to follow when contributing to the documentation.
 
 Where to Send Patches
 =====================
@@ -19,11 +22,11 @@  Where to Send Patches
 When sending single patches, please using something like:
 'git send-email -1 --to docs@lists.yoctoproject.org
 
-The To header can be set as default for this repository:
+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.
 
-Git repository: http://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/
+Git repository: https://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/
 Mailing list: docs@lists.yoctoproject.org