summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorQuentin Schulz <quentin.schulz@cherry.de>2025-06-05 16:10:23 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2025-06-06 22:22:43 +0100
commitac52e9a94fe5dac8e6289c228b6ba7c966c72331 (patch)
tree8de852ef2a0c709502f6bd5003e5d5e39627f5dd
parent968fd3ad5415d38ca7e9d75487c74f50cc248de1 (diff)
downloadpoky-ac52e9a94fe5dac8e6289c228b6ba7c966c72331.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: 0298318cea2947e65754eab97255164e64a862de) Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/README21
1 files changed, 19 insertions, 2 deletions
diff --git a/documentation/README b/documentation/README
index 8a47fd4a3f..02037e0f7e 100644
--- a/documentation/README
+++ b/documentation/README
@@ -406,5 +406,22 @@ both the Yocto Project and BitBake manuals:
406Submitting documentation changes 406Submitting documentation changes
407================================ 407================================
408 408
409Please see the top level README file in this repository for details of where 409Please refer to our contributor guide here: https://docs.yoctoproject.org/contributor-guide/
410to send patches. 410for full details on how to submit changes.
411
412As a quick guide, patches should be sent to docs@lists.yoctoproject.org
413The git command to do that would be:
414
415 git send-email -M -1 --to docs@lists.yoctoproject.org
416
417The 'To' header can be set as default for this repository:
418
419 git config sendemail.to docs@lists.yoctoproject.org
420
421Now you can just do 'git send-email origin/master..' to send all local patches.
422
423Read the other sections in this document and documentation/standards.md for
424rules to follow when contributing to the documentation.
425
426Git repository: https://git.yoctoproject.org/yocto-docs
427Mailing list: docs@lists.yoctoproject.org