mbox series

[0/2] README: fix contribution instructions when included in poky

Message ID 20250605-readme-contrib-v1-0-c51b8cc57b7a@cherry.de
Headers show
Series README: fix contribution instructions when included in poky | expand

Message

Quentin Schulz June 5, 2025, 2:10 p.m. UTC 
While trying to explain how to figure out which mailing list to
contribute to based on the changed files in poky, I discovered a few
things:

- the contribution instructions in documentation/README point to
  "top-level README", but
- yocto-docs's top-level README isn't copied in poky and poky doesn't
  have one,

So let's make the contribution instructions part of
documentation/README. Considering that this document now contains
everything the top-level README contains, there's no need to duplicate
its content partially. Keeping a README file at the top of a git repo is
kind of best practice so let's just make it a symlink to
documentation/README.

Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
---
Quentin Schulz (2):
      docs: README: specify how to contribute instead of pointing at another file
      deduplicate README

 README               | 32 +-------------------------------
 documentation/README | 21 +++++++++++++++++++--
 2 files changed, 20 insertions(+), 33 deletions(-)
---
base-commit: 406e8a8e30404c0538f5aa46f211540bae2b206b
change-id: 20250605-readme-contrib-7277b00cec93

Best regards,