summaryrefslogtreecommitdiffstats
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-11 08:17:34 -0700
commit82a79624617f57049f5d57858a6bf1c65ad6c975 (patch)
tree0d3b421272d3a61655b29c0f5b09ec1b8631dd83
parentd802c980449f6911bd11f0db374ab177fd8409d3 (diff)
downloadpoky-82a79624617f57049f5d57858a6bf1c65ad6c975.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: 01f1595d87dfb759071198d64c9a62fb00a48545) 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>
-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