summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorQuentin Schulz <quentin.schulz@cherry.de>2025-06-05 16:10:23 +0200
committerSteve Sakoman <steve@sakoman.com>2025-06-13 08:42:36 -0700
commit0d1428e5b810f6c69f8cbdb7c27485afa091eb32 (patch)
tree8d58b82c20e287c21a77370ed2f24e60b7513c9c /documentation
parent1df4bec5eb85ddadcd7171047be0a70e494aec23 (diff)
downloadpoky-0d1428e5b810f6c69f8cbdb7c27485afa091eb32.tar.gz
docs: README: specify how to contribute instead of pointing at another file
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. (From yocto-docs rev: acad3d63501d1ee8bd0759438f456488ca7869bf) Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 0298318cea2947e65754eab97255164e64a862de) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/README21
1 files changed, 19 insertions, 2 deletions
diff --git a/documentation/README b/documentation/README
index d7428eb8ed..c394ab9288 100644
--- a/documentation/README
+++ b/documentation/README
@@ -429,5 +429,22 @@ both the Yocto Project and BitBake manuals:
429Submitting documentation changes 429Submitting documentation changes
430================================ 430================================
431 431
432Please see the top level README file in this repository for details of where 432Please refer to our contributor guide here: https://docs.yoctoproject.org/contributor-guide/
433to send patches. 433for full details on how to submit changes.
434
435As a quick guide, patches should be sent to docs@lists.yoctoproject.org
436The git command to do that would be:
437
438 git send-email -M -1 --to docs@lists.yoctoproject.org
439
440The 'To' header can be set as default for this repository:
441
442 git config sendemail.to docs@lists.yoctoproject.org
443
444Now you can just do 'git send-email origin/master..' to send all local patches.
445
446Read the other sections in this document and documentation/standards.md for
447rules to follow when contributing to the documentation.
448
449Git repository: https://git.yoctoproject.org/yocto-docs
450Mailing list: docs@lists.yoctoproject.org