diff mbox series

README: Clarify/standardise contributions process

Message ID 20230830153927.2016454-1-richard.purdie@linuxfoundation.org (mailing list archive)
State New
Headers show
Series README: Clarify/standardise contributions process | expand

Commit Message

Richard Purdie Aug. 30, 2023, 3:39 p.m. UTC
Now we have a contributor guide combining various wiki pages, point at
that and standarise our approach across layers.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
---
 meta-poky/README.poky.md          | 15 ++-------------
 meta-yocto-bsp/README.hardware.md | 15 ++++++++++++---
 2 files changed, 14 insertions(+), 16 deletions(-)

Comments

Bas Mevissen Aug. 30, 2023, 3:55 p.m. UTC | #1
On 2023-08-30 17:39, Richard Purdie wrote:
> Now we have a contributor guide combining various wiki pages, point at
> that and standarise our approach across layers.
> 

I get a 404 on https://docs.yoctoproject.org/dev/contributor-guide/
where 
https://www.openembedded.org/wiki/How_to_submit_a_patch_to_OpenEmbedded 
is pointing to.

Bas.

> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
> ---
>  meta-poky/README.poky.md          | 15 ++-------------
>  meta-yocto-bsp/README.hardware.md | 15 ++++++++++++---
>  2 files changed, 14 insertions(+), 16 deletions(-)
> 
> diff --git a/meta-poky/README.poky.md b/meta-poky/README.poky.md
> index a99c75ed5cb..7dd5e6d8316 100644
> --- a/meta-poky/README.poky.md
> +++ b/meta-poky/README.poky.md
> @@ -34,19 +34,8 @@ For information about OpenEmbedded, see the
>  Contribution Guidelines
>  -----------------------
> 
> -The project works using a mailing list patch submission process. 
> Patches
> -should be sent to the mailing list for the repository the components
> -originate from (see below). Throughout the Yocto Project, the README
> -files in the component in question should detail where to send 
> patches,
> -who the maintainers are and where bugs should be reported.
> -
> -A guide to submitting patches to OpenEmbedded is available at:
> -
> -<https://www.openembedded.org/wiki/How_to_submit_a_patch_to_OpenEmbedded>
> -
> -There is good documentation on how to write/format patches at:
> -
> -<https://www.openembedded.org/wiki/Commit_Patch_Message_Guidelines>
> +Please refer to our contributor guide here:
> https://docs.yoctoproject.org/dev/contributor-guide/
> +for full details on how to submit changes.
> 
>  Where to Send Patches
>  ---------------------
> diff --git a/meta-yocto-bsp/README.hardware.md
> b/meta-yocto-bsp/README.hardware.md
> index 8ea0ef14614..a8f38cb21a6 100644
> --- a/meta-yocto-bsp/README.hardware.md
> +++ b/meta-yocto-bsp/README.hardware.md
> @@ -33,10 +33,19 @@ The following boards are supported by the
> meta-yocto-bsp layer:
>  For more information see the board's section below. The appropriate 
> MACHINE
>  variable value corresponding to the board is given in brackets.
> 
> -Reference Board Maintenance
> -===========================
> +Reference Board Maintenance and Contributions
> +=============================================
> +
> +Please refer to our contributor guide here:
> https://docs.yoctoproject.org/dev/contributor-guide/
> +for full details on how to submit changes.
> +
> +As a quick guide, patches should be sent to 
> poky@lists.yoctoproject.org
> +The git command to do that would be:
> +
> +     git send-email -M -1 --to poky@lists.yoctoproject.org
> 
> -Send pull requests, patches, comments or questions about
> meta-yocto-bsps to poky@lists.yoctoproject.org
> +Send pull requests, patches, comments or questions about 
> meta-yocto-bsp to
> +poky@lists.yoctoproject.org
> 
>  Maintainers: Kevin Hao <kexin.hao@windriver.com>
>               Bruce Ashfield <bruce.ashfield@gmail.com>
> 
> -=-=-=-=-=-=-=-=-=-=-=-
> Links: You receive all messages sent to this group.
> View/Reply Online (#13138): 
> https://lists.yoctoproject.org/g/poky/message/13138
> Mute This Topic: https://lists.yoctoproject.org/mt/101055098/3617169
> Group Owner: poky+owner@lists.yoctoproject.org
> Unsubscribe:
> https://lists.yoctoproject.org/g/poky/leave/6694068/3617169/1811455910/xyzzy
> [abuse@basmevissen.nl]
> -=-=-=-=-=-=-=-=-=-=-=-
Richard Purdie Aug. 30, 2023, 4 p.m. UTC | #2
On Wed, 2023-08-30 at 17:55 +0200, Bas Mevissen wrote:
> On 2023-08-30 17:39, Richard Purdie wrote:
> > Now we have a contributor guide combining various wiki pages, point at
> > that and standarise our approach across layers.
> > 
> 
> I get a 404 on https://docs.yoctoproject.org/dev/contributor-guide/
> where 
> https://www.openembedded.org/wiki/How_to_submit_a_patch_to_OpenEmbedded 
> is pointing to.

The server is busy processing the docs patches and it will appear there
soon as the docs build completes. You can see it right now at:

https://docs.yoctoproject.org/next/contributor-guide/

Cheers,

Richard
Bas Mevissen Aug. 30, 2023, 4:22 p.m. UTC | #3
On 2023-08-30 18:00, Richard Purdie wrote:
> On Wed, 2023-08-30 at 17:55 +0200, Bas Mevissen wrote:
>> On 2023-08-30 17:39, Richard Purdie wrote:
>> > Now we have a contributor guide combining various wiki pages, point at
>> > that and standarise our approach across layers.
>> >
>> 
>> I get a 404 on https://docs.yoctoproject.org/dev/contributor-guide/
>> where
>> https://www.openembedded.org/wiki/How_to_submit_a_patch_to_OpenEmbedded
>> is pointing to.
> 
> The server is busy processing the docs patches and it will appear there
> soon as the docs build completes. You can see it right now at:
> 

Ok, thanks for the clarification.

> https://docs.yoctoproject.org/next/contributor-guide/
> 

Nice piece of work. Would be an asset for every open source project!

> Cheers,
> 
> Richard
> 

Cheers,

Bas.

> 
> 
> 
> -=-=-=-=-=-=-=-=-=-=-=-
> Links: You receive all messages sent to this group.
> View/Reply Online (#13140): 
> https://lists.yoctoproject.org/g/poky/message/13140
> Mute This Topic: https://lists.yoctoproject.org/mt/101055098/3617169
> Group Owner: poky+owner@lists.yoctoproject.org
> Unsubscribe:
> https://lists.yoctoproject.org/g/poky/leave/6694068/3617169/1811455910/xyzzy
> [abuse@basmevissen.nl]
> -=-=-=-=-=-=-=-=-=-=-=-
diff mbox series

Patch

diff --git a/meta-poky/README.poky.md b/meta-poky/README.poky.md
index a99c75ed5cb..7dd5e6d8316 100644
--- a/meta-poky/README.poky.md
+++ b/meta-poky/README.poky.md
@@ -34,19 +34,8 @@  For information about OpenEmbedded, see the
 Contribution Guidelines
 -----------------------
 
-The project works using a mailing list patch submission process. Patches
-should be sent to the mailing list for the repository the components
-originate from (see below). Throughout the Yocto Project, the README
-files in the component in question should detail where to send patches,
-who the maintainers are and where bugs should be reported.
-
-A guide to submitting patches to OpenEmbedded is available at:
-
-<https://www.openembedded.org/wiki/How_to_submit_a_patch_to_OpenEmbedded>
-
-There is good documentation on how to write/format patches at:
-
-<https://www.openembedded.org/wiki/Commit_Patch_Message_Guidelines>
+Please refer to our contributor guide here: https://docs.yoctoproject.org/dev/contributor-guide/
+for full details on how to submit changes.
 
 Where to Send Patches
 ---------------------
diff --git a/meta-yocto-bsp/README.hardware.md b/meta-yocto-bsp/README.hardware.md
index 8ea0ef14614..a8f38cb21a6 100644
--- a/meta-yocto-bsp/README.hardware.md
+++ b/meta-yocto-bsp/README.hardware.md
@@ -33,10 +33,19 @@  The following boards are supported by the meta-yocto-bsp layer:
 For more information see the board's section below. The appropriate MACHINE
 variable value corresponding to the board is given in brackets.
 
-Reference Board Maintenance
-===========================
+Reference Board Maintenance and Contributions
+=============================================
+
+Please refer to our contributor guide here: https://docs.yoctoproject.org/dev/contributor-guide/
+for full details on how to submit changes.
+
+As a quick guide, patches should be sent to poky@lists.yoctoproject.org
+The git command to do that would be:
+ 
+     git send-email -M -1 --to poky@lists.yoctoproject.org
 
-Send pull requests, patches, comments or questions about meta-yocto-bsps to poky@lists.yoctoproject.org
+Send pull requests, patches, comments or questions about meta-yocto-bsp to 
+poky@lists.yoctoproject.org
 
 Maintainers: Kevin Hao <kexin.hao@windriver.com>
              Bruce Ashfield <bruce.ashfield@gmail.com>