diff mbox series

README: Update to point to new contributor guide

Message ID 20230830154445.2017109-1-richard.purdie@linuxfoundation.org
State New
Headers show
Series README: Update to point to new contributor guide | expand

Commit Message

Richard Purdie Aug. 30, 2023, 3:44 p.m. UTC
Now we have a contributor guide combining various wiki pages, point at
that and tweak to match our other READMEs.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
---
 README | 19 +++++++++----------
 1 file changed, 9 insertions(+), 10 deletions(-)

Comments

Michael Opdenacker Sept. 6, 2023, 8:11 a.m. UTC | #1
Hi Richard,

On 30.08.23 at 17:44, Richard Purdie wrote:
> Now we have a contributor guide combining various wiki pages, point at
> that and tweak to match our other READMEs.
>
> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
> ---
>   README | 19 +++++++++----------
>   1 file changed, 9 insertions(+), 10 deletions(-)
>
> diff --git a/README b/README
> index 85d8d837b..dfbf7bf0e 100644
> --- a/README
> +++ b/README
> @@ -10,23 +10,22 @@ An online version of the documentation can be found at:
>   Contributing
>   ============
>   
> -See https://www.openembedded.org/wiki/How_to_submit_a_patch_to_OpenEmbedded
> -for generic guidelines for configuring Git and preparing patches.
> +Please refer to our contributor guide here: https://docs.yoctoproject.org/dev/contributor-guide/
> +for full details on how to submit changes.


Thanks for the update and fixes.
However, let me first add the current version of the contributor guide 
to the mickledore branch, so that we can refer to this guide through its 
final URL:
https://docs.yoctoproject.org/contributor-guide/

Then, I'll update and merge your change.
Cheers,
Michael.
Michael Opdenacker Sept. 7, 2023, 9:30 a.m. UTC | #2
On 06.09.23 at 10:11, Michael Opdenacker via lists.yoctoproject.org wrote:
> Hi Richard,
>
> On 30.08.23 at 17:44, Richard Purdie wrote:
>> Now we have a contributor guide combining various wiki pages, point at
>> that and tweak to match our other READMEs.
>>
>> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
>> ---
>>   README | 19 +++++++++----------
>>   1 file changed, 9 insertions(+), 10 deletions(-)
>>
>> diff --git a/README b/README
>> index 85d8d837b..dfbf7bf0e 100644
>> --- a/README
>> +++ b/README
>> @@ -10,23 +10,22 @@ An online version of the documentation can be 
>> found at:
>>   Contributing
>>   ============
>>   -See 
>> https://www.openembedded.org/wiki/How_to_submit_a_patch_to_OpenEmbedded
>> -for generic guidelines for configuring Git and preparing patches.
>> +Please refer to our contributor guide here: 
>> https://docs.yoctoproject.org/dev/contributor-guide/
>> +for full details on how to submit changes.
>
>
> Thanks for the update and fixes.
> However, let me first add the current version of the contributor guide 
> to the mickledore branch, so that we can refer to this guide through 
> its final URL:
> https://docs.yoctoproject.org/contributor-guide/
>
> Then, I'll update and merge your change.


Done
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Thanks again
Michael
diff mbox series

Patch

diff --git a/README b/README
index 85d8d837b..dfbf7bf0e 100644
--- a/README
+++ b/README
@@ -10,23 +10,22 @@  An online version of the documentation can be found at:
 Contributing
 ============
 
-See https://www.openembedded.org/wiki/How_to_submit_a_patch_to_OpenEmbedded
-for generic guidelines for configuring Git and preparing patches.
+Please refer to our contributor guide here: https://docs.yoctoproject.org/dev/contributor-guide/
+for full details on how to submit changes.
 
-Read the documentation/README and documentation/standards.md files
-for rules to follow when contributing to the documentation.
-
-Where to Send Patches
-=====================
+As a quick guide, patches should be sent to docs@lists.yoctoproject.org
+The git command to do that would be:
 
-When sending single patches, please using something like:
-'git send-email -1 --to docs@lists.yoctoproject.org
+     git send-email -M -1 --to docs@lists.yoctoproject.org
 
 The 'To' header can be set as default for this repository:
 
-$ git config sendemail.to docs@lists.yoctoproject.org
+     git config sendemail.to docs@lists.yoctoproject.org
 
 Now you can just do 'git send-email origin/master..' to send all local patches.
 
+Read the documentation/README and documentation/standards.md files
+for rules to follow when contributing to the documentation.
+
 Git repository: https://git.yoctoproject.org/yocto-docs
 Mailing list: docs@lists.yoctoproject.org