diff mbox

[1,of,8] manual: contributing: expand introduction

Message ID 6f236594e86703960655.1394036667@argentina
State Accepted
Headers show

Commit Message

Thomas De Schampheleire March 5, 2014, 4:24 p.m. UTC
This patch expands the introduction of the "Contributing to buildroot"
section. In general, the intention of this and subsequent patches is to
promote non-feature contributions, like autobuild fixes, bug report
analysis, TODO list work, etc.

Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>

---
 docs/manual/contribute.txt |  31 ++++++++++++++++++++-----------
 1 files changed, 20 insertions(+), 11 deletions(-)

Comments

Yann E. MORIN March 5, 2014, 5:11 p.m. UTC | #1
Thomas, All,

On 2014-03-05 17:24 +0100, Thomas De Schampheleire spake thusly:
> This patch expands the introduction of the "Contributing to buildroot"
> section. In general, the intention of this and subsequent patches is to
> promote non-feature contributions, like autobuild fixes, bug report
> analysis, TODO list work, etc.
> 
> Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>

Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr>

Regards,
Yann E. MORIN.

> ---
>  docs/manual/contribute.txt |  31 ++++++++++++++++++++-----------
>  1 files changed, 20 insertions(+), 11 deletions(-)
> 
> diff --git a/docs/manual/contribute.txt b/docs/manual/contribute.txt
> --- a/docs/manual/contribute.txt
> +++ b/docs/manual/contribute.txt
> @@ -2,26 +2,35 @@
>  // vim: set syntax=asciidoc:
>  
>  Contributing to Buildroot
> -========================
> +=========================
>  
> -If you want to contribute to Buildroot, you will need a git view of
> -the project. Refer to xref:getting-buildroot[] to get it.
> +There are many ways in which you can contribute to Buildroot: analyzing
> +and fixing bugs, analyzing and fixing package build failures detected by
> +the autobuilders, testing and reviewing patches sent by other
> +developers, working on the items in our TODO list and sending your own
> +improvements to Buildroot or its manual. The following sections give a
> +little more detail on each of these items.
>  
> -Currently, the mailing list is the central place for contribution.
> -If you have not already subscribed to it, then refer to
> +If you are interested in contributing to Buildroot, the first thing you
> +should do is to subscribe to the Buildroot mailing list. This list is
> +the main way of interacting with other Buildroot developers and to send
> +contributions to. If you aren't subscribed yet, then refer to
>  xref:mailing-list-subscribe[].
>  
> -Recently, a web interface is also used to manage patches sent to the
> -mailing list, see xref:patchwork[].
> -
> -[NOTE]
> -_Please, do not attach patches to bugs, send them to the mailing list
> -instead_ (see xref:submitting-patches[]).
> +If you are going to touch the code, it is highly recommended to use a
> +git repository of Buildroot, rather than starting from an extracted
> +source code tarball. Git is the easiest way to develop from and directly
> +send your patches to the mailing list. Refer to xref:getting-buildroot[]
> +for more information on obtaining a Buildroot git tree.
>  
>  [[submitting-patches]]
>  Submitting patches
>  ------------------
>  
> +[NOTE]
> +_Please, do not attach patches to bugs, send them to the mailing list
> +instead_.
> +
>  When your changes are done, and committed in your local git view,
>  _rebase_ your development branch on top of the upstream tree before
>  generating the patch set. To do so, run:
> _______________________________________________
> buildroot mailing list
> buildroot@busybox.net
> http://lists.busybox.net/mailman/listinfo/buildroot
Samuel Martin March 5, 2014, 8:50 p.m. UTC | #2
On Wed, Mar 5, 2014 at 6:11 PM, Yann E. MORIN <yann.morin.1998@free.fr> wrote:
> Thomas, All,
>
> On 2014-03-05 17:24 +0100, Thomas De Schampheleire spake thusly:
>> This patch expands the introduction of the "Contributing to buildroot"
>> section. In general, the intention of this and subsequent patches is to
>> promote non-feature contributions, like autobuild fixes, bug report
>> analysis, TODO list work, etc.
>>
>> Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
>
> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr>

Acked-by: Samuel Martin <s.martin49@gmail.com>

Regards,
diff mbox

Patch

diff --git a/docs/manual/contribute.txt b/docs/manual/contribute.txt
--- a/docs/manual/contribute.txt
+++ b/docs/manual/contribute.txt
@@ -2,26 +2,35 @@ 
 // vim: set syntax=asciidoc:
 
 Contributing to Buildroot
-========================
+=========================
 
-If you want to contribute to Buildroot, you will need a git view of
-the project. Refer to xref:getting-buildroot[] to get it.
+There are many ways in which you can contribute to Buildroot: analyzing
+and fixing bugs, analyzing and fixing package build failures detected by
+the autobuilders, testing and reviewing patches sent by other
+developers, working on the items in our TODO list and sending your own
+improvements to Buildroot or its manual. The following sections give a
+little more detail on each of these items.
 
-Currently, the mailing list is the central place for contribution.
-If you have not already subscribed to it, then refer to
+If you are interested in contributing to Buildroot, the first thing you
+should do is to subscribe to the Buildroot mailing list. This list is
+the main way of interacting with other Buildroot developers and to send
+contributions to. If you aren't subscribed yet, then refer to
 xref:mailing-list-subscribe[].
 
-Recently, a web interface is also used to manage patches sent to the
-mailing list, see xref:patchwork[].
-
-[NOTE]
-_Please, do not attach patches to bugs, send them to the mailing list
-instead_ (see xref:submitting-patches[]).
+If you are going to touch the code, it is highly recommended to use a
+git repository of Buildroot, rather than starting from an extracted
+source code tarball. Git is the easiest way to develop from and directly
+send your patches to the mailing list. Refer to xref:getting-buildroot[]
+for more information on obtaining a Buildroot git tree.
 
 [[submitting-patches]]
 Submitting patches
 ------------------
 
+[NOTE]
+_Please, do not attach patches to bugs, send them to the mailing list
+instead_.
+
 When your changes are done, and committed in your local git view,
 _rebase_ your development branch on top of the upstream tree before
 generating the patch set. To do so, run: