[PATCH] README: add "Contributing" section

[PATCH] README: add "Contributing" section

[Mario Domenech Goulart]

Tips on how to submit patches.

Signed-off-by: Mario Domenech Goulart <mario@ossystems.com.br>
---
 README |   21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/README b/README
index 665c98f..bbd7234 100644
--- a/README
+++ b/README
@@ -13,3 +13,24 @@ which can be found at:
     http://yoctoproject.org/documentation
 
 
+Contributing
+------------
+
+To contribute to this layer you should submit the patches for
+review to the mailing list (openembedded-core@lists.openembedded.org).
+
+Please refer to:
+http://www.openembedded.org/wiki/Commit_Patch_Message_Guidelines
+for some useful guidelines to be followed when submitting patches.
+
+Mailing list:
+
+    http://lists.openembedded.org/mailman/listinfo/openembedded-core
+
+Source code:
+
+    http://git.openembedded.org/openembedded-core/
+
+When sending patches, please use something like:
+
+    git send-email --to openembedded-core@lists.openembedded.org <patches>
-- 
1.7.10.4

Re: [PATCH] README: add "Contributing" section

[Otavio Salvador]

On Tue, May 12, 2015 at 11:58 AM, Mario Domenech Goulart
<mario@ossystems.com.br> wrote:
> Tips on how to submit patches.
>
> Signed-off-by: Mario Domenech Goulart <mario@ossystems.com.br>

Acked-by: Otavio Salvador <otavio@ossystems.com.br>

-- 
Otavio Salvador                             O.S. Systems
http://www.ossystems.com.br        http://code.ossystems.com.br
Mobile: +55 (53) 9981-7854            Mobile: +1 (347) 903-9750

Re: [PATCH] README: add "Contributing" section

[Anders Darander]

* Mario Domenech Goulart <mario@ossystems.com.br> [150512 16:58]:
> +Contributing
> +------------
> +
> +To contribute to this layer you should submit the patches for
> +review to the mailing list (openembedded-core@lists.openembedded.org).
> +
> +Please refer to:
> +http://www.openembedded.org/wiki/Commit_Patch_Message_Guidelines
> +for some useful guidelines to be followed when submitting patches.
> +
> +Mailing list:
> +
> +    http://lists.openembedded.org/mailman/listinfo/openembedded-core
> +
> +Source code:
> +
> +    http://git.openembedded.org/openembedded-core/
> +
> +When sending patches, please use something like:
> +
> +    git send-email --to openembedded-core@lists.openembedded.org <patches>


Maybe we could add something about the helper scripts:

scripts/create-pull-request
scripts/send-pull-request

or do you think that those scripts might be out of scope for the primary
intended audience of this section?

Cheers,
Anders

-- 
Anders Darander
ChargeStorm AB / eStorm AB

Re: [PATCH] README: add "Contributing" section

[Paul Eggleton]

On Wednesday 13 May 2015 07:17:01 Anders Darander wrote:
> * Mario Domenech Goulart <mario@ossystems.com.br> [150512 16:58]:
> > +Contributing
> > +------------
> > +
> > +To contribute to this layer you should submit the patches for
> > +review to the mailing list (openembedded-core@lists.openembedded.org).
> > +
> > +Please refer to:
> > +http://www.openembedded.org/wiki/Commit_Patch_Message_Guidelines
> > +for some useful guidelines to be followed when submitting patches.
> > +
> > +Mailing list:
> > +
> > +    http://lists.openembedded.org/mailman/listinfo/openembedded-core
> > +
> > +Source code:
> > +
> > +    http://git.openembedded.org/openembedded-core/
> > +
> > +When sending patches, please use something like:
> > +
> > +    git send-email --to openembedded-core@lists.openembedded.org
> > <patches>
> 
> Maybe we could add something about the helper scripts:
> 
> scripts/create-pull-request
> scripts/send-pull-request
> 
> or do you think that those scripts might be out of scope for the primary
> intended audience of this section?

My suggestion would be to link to the following page instead which covers all 
the options and explains how to use them:

  http://www.openembedded.org/wiki/How_to_submit_a_patch_to_OpenEmbedded

We can probably drop the "commit message guidelines" link at the same time 
since the above page already links to that.

Cheers,
Paul

-- 

Paul Eggleton
Intel Open Source Technology Centre

Re: [PATCH] README: add "Contributing" section

[Mario Domenech Goulart]

On Wed, 13 May 2015 09:54:39 +0100 Paul Eggleton <paul.eggleton@linux.intel.com> wrote:

> On Wednesday 13 May 2015 07:17:01 Anders Darander wrote:
>> * Mario Domenech Goulart <mario@ossystems.com.br> [150512 16:58]:
>> > +Contributing
>> > +------------
>> > +
>> > +To contribute to this layer you should submit the patches for
>> > +review to the mailing list (openembedded-core@lists.openembedded.org).
>> > +
>> > +Please refer to:
>> > +http://www.openembedded.org/wiki/Commit_Patch_Message_Guidelines
>> > +for some useful guidelines to be followed when submitting patches.
>> > +
>> > +Mailing list:
>> > +
>> > +    http://lists.openembedded.org/mailman/listinfo/openembedded-core
>> > +
>> > +Source code:
>> > +
>> > +    http://git.openembedded.org/openembedded-core/
>> > +
>> > +When sending patches, please use something like:
>> > +
>> > +    git send-email --to openembedded-core@lists.openembedded.org
>> > <patches>
>> 
>> Maybe we could add something about the helper scripts:
>> 
>> scripts/create-pull-request
>> scripts/send-pull-request
>> 
>> or do you think that those scripts might be out of scope for the primary
>> intended audience of this section?
>
> My suggestion would be to link to the following page instead which covers all 
> the options and explains how to use them:
>
>   http://www.openembedded.org/wiki/How_to_submit_a_patch_to_OpenEmbedded
>
> We can probably drop the "commit message guidelines" link at the same time 
> since the above page already links to that.

Thanks guys for the suggestions.

Paul: do you mean dropping everything and add something like


Contributing
------------

Please refer to
http://www.openembedded.org/wiki/How_to_submit_a_patch_to_OpenEmbedded
for guidelines on how to submit patches.


?  Or keep everything and just replace the guidelines link?

Best wishes.
Mario
-- 
http://www.ossystems.com.br

Re: [PATCH] README: add "Contributing" section

[Paul Eggleton]

On Wednesday 13 May 2015 13:07:28 Mario Domenech Goulart wrote:
> On Wed, 13 May 2015 09:54:39 +0100 Paul Eggleton 
<paul.eggleton@linux.intel.com> wrote:
> > On Wednesday 13 May 2015 07:17:01 Anders Darander wrote:
> >> * Mario Domenech Goulart <mario@ossystems.com.br> [150512 16:58]:
> >> > +Contributing
> >> > +------------
> >> > +
> >> > +To contribute to this layer you should submit the patches for
> >> > +review to the mailing list (openembedded-core@lists.openembedded.org).
> >> > +
> >> > +Please refer to:
> >> > +http://www.openembedded.org/wiki/Commit_Patch_Message_Guidelines
> >> > +for some useful guidelines to be followed when submitting patches.
> >> > +
> >> > +Mailing list:
> >> > +
> >> > +    http://lists.openembedded.org/mailman/listinfo/openembedded-core
> >> > +
> >> > +Source code:
> >> > +
> >> > +    http://git.openembedded.org/openembedded-core/
> >> > +
> >> > +When sending patches, please use something like:
> >> > +
> >> > +    git send-email --to openembedded-core@lists.openembedded.org
> >> > <patches>
> >> 
> >> Maybe we could add something about the helper scripts:
> >> 
> >> scripts/create-pull-request
> >> scripts/send-pull-request
> >> 
> >> or do you think that those scripts might be out of scope for the primary
> >> intended audience of this section?
> > 
> > My suggestion would be to link to the following page instead which covers
> > all> 
> > the options and explains how to use them:
> >   http://www.openembedded.org/wiki/How_to_submit_a_patch_to_OpenEmbedded
> > 
> > We can probably drop the "commit message guidelines" link at the same time
> > since the above page already links to that.
> 
> Thanks guys for the suggestions.
> 
> Paul: do you mean dropping everything and add something like
> 
> 
> Contributing
> ------------
> 
> Please refer to
> http://www.openembedded.org/wiki/How_to_submit_a_patch_to_OpenEmbedded
> for guidelines on how to submit patches.
> 
> 
> ?  Or keep everything and just replace the guidelines link?

I think the best plan would be to 1) edit the contributing section as you 
posted above, and 2) drop the "When sending patches..." bit.

Cheers,
Paul

-- 

Paul Eggleton
Intel Open Source Technology Centre