From patchwork Sun Nov 11 13:14:53 2012 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Samuel Martin X-Patchwork-Id: 198276 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from silver.osuosl.org (silver.osuosl.org [140.211.166.136]) by ozlabs.org (Postfix) with ESMTP id 06E0B2C0089 for ; Mon, 12 Nov 2012 00:17:38 +1100 (EST) Received: from localhost (localhost [127.0.0.1]) by silver.osuosl.org (Postfix) with ESMTP id 9450731489; Sun, 11 Nov 2012 13:17:36 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Received: from silver.osuosl.org ([127.0.0.1]) by localhost (.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id xkVraoqalaCm; Sun, 11 Nov 2012 13:17:28 +0000 (UTC) Received: from ash.osuosl.org (ash.osuosl.org [140.211.166.34]) by silver.osuosl.org (Postfix) with ESMTP id 7BE903106D; Sun, 11 Nov 2012 13:16:37 +0000 (UTC) X-Original-To: buildroot@lists.busybox.net Delivered-To: buildroot@osuosl.org Received: from whitealder.osuosl.org (whitealder.osuosl.org [140.211.166.138]) by ash.osuosl.org (Postfix) with ESMTP id E56A58F753 for ; Sun, 11 Nov 2012 13:15:47 +0000 (UTC) Received: from localhost (localhost [127.0.0.1]) by whitealder.osuosl.org (Postfix) with ESMTP id B80C38C2A6 for ; Sun, 11 Nov 2012 13:15:43 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Received: from whitealder.osuosl.org ([127.0.0.1]) by localhost (.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id Imu3N5-2X8KB for ; Sun, 11 Nov 2012 13:15:42 +0000 (UTC) X-Greylist: domain auto-whitelisted by SQLgrey-1.7.6 Received: from mail-we0-f171.google.com (mail-we0-f171.google.com [74.125.82.171]) by whitealder.osuosl.org (Postfix) with ESMTPS id 349098C2D7 for ; Sun, 11 Nov 2012 13:15:42 +0000 (UTC) Received: by mail-we0-f171.google.com with SMTP id s43so3028443wey.16 for ; Sun, 11 Nov 2012 05:15:41 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=from:to:cc:subject:date:message-id:x-mailer:in-reply-to:references; bh=b/BVVgJv4Q9PXkeKK7UtgMqwPibDGjOGWkfZuCX2/7A=; b=o0TcN+Um0GabKCkHULh1NR0IdeWO9+HoowHV5IQwt1Qf74TNQRUKenTWHEDKCrE41u 1RGb4O4l9QISQZnjmIcsTcPtlyg/QCvyWiKNiJsx4gkwV7DAUdrqSbVBqcBadIxnj2EB /YUqlvbJ1WrhGo8N8iFncuAUgdaMTSUgdn1eCecAZvPyDp44oFUFVBzDqUrBJB6B3LAF Is6oOcMsExLrkYZ/Fo+av601ABIXtv1AQusJ8LG4bt2IDKEtIrKAjUU5Mex+RyblBMtR h/kj2hl2V9FdRb4Gr8aqmFmcFVN7JBIOpWklh+A+uf4uIJJabfJ9vk8+5riMcVM5N5Ax lOdQ== Received: by 10.216.207.93 with SMTP id m71mr6324580weo.201.1352639741908; Sun, 11 Nov 2012 05:15:41 -0800 (PST) Received: from localhost.localdomain (ivr94-4-82-229-165-48.fbx.proxad.net. [82.229.165.48]) by mx.google.com with ESMTPS id hv4sm10262550wib.0.2012.11.11.05.15.40 (version=SSLv3 cipher=OTHER); Sun, 11 Nov 2012 05:15:41 -0800 (PST) From: Samuel Martin To: buildroot@busybox.net Date: Sun, 11 Nov 2012 14:14:53 +0100 Message-Id: <1352639701-27829-16-git-send-email-s.martin49@gmail.com> X-Mailer: git-send-email 1.8.0 In-Reply-To: <1352639701-27829-1-git-send-email-s.martin49@gmail.com> References: <1352639701-27829-1-git-send-email-s.martin49@gmail.com> Subject: [Buildroot] [PATCH 15/23] manual: add contribute.txt X-BeenThere: buildroot@busybox.net X-Mailman-Version: 2.1.14 Precedence: list List-Id: Discussion and development of buildroot List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Errors-To: buildroot-bounces@busybox.net Sender: buildroot-bounces@busybox.net Signed-off-by: Samuel Martin create mode 100644 docs/manual/contribute.txt diff --git a/docs/manual/contribute.txt b/docs/manual/contribute.txt new file mode 100644 index 0000000..ddf790d --- /dev/null +++ b/docs/manual/contribute.txt @@ -0,0 +1,126 @@ +// -*- mode:doc; -*- + +Contibuting 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. + +Currently, the mailing list is the central place for contribution. +If you have not already subscribed to it, 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[]). + +[[submitting-patches]] +Submitting patches +------------------ + +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: + +--------------------- + $ git fetch --all --tags + $ git rebase origin/master +--------------------- + +Here, you are ready to generate then submit your patch set. + +To generate it, run: + +--------------------- + $ git format-patch -M -n -s -o outgoing origin/master +--------------------- + +This will generate patch files in the +outgoing+ subdirectory, +automatically adding the +signed-off-by+ line. + +If you want to present the whole patch set in a separate mail, add ++--cover-letter --summary+ to the previous command line (+man +git-format-patch+ for further information). + +Once patch files are generated, you can review/edit the commit message +before submitting them using your favorite text editor. + +Lastly, send/submit your patch set to the Buildroot mailing list: + +--------------------- + $ git send-email --to buildroot@busybox.net outgoing/* +--------------------- + +Note that +git+ should be configured to use your mail account. +To configure +git+, see +man git-send-email+ or google it. + +Make sure posted *patches are not line-wrapped*, otherwise it cannot +easily be applied. In such a case, fix your e-mail client, or better, +use +git send-email+ to send your patches. + +Reviewing/Testing patches +------------------------- + +In the review process, do not hesitate to respond to patch submissions +for remarks, suggestions or anything that will help everyone to +understand the patches and make them better. + +Some tags are used to help following the state of any patch posted on +the mailing-list: + +Acked-by:: Indicates that the patch can be committed. + +Tested-by:: Indicates that the patch has been tested. It is useful + but not necessary to add a comment about what has been tested. + +Autobuild +--------- + +The Buildroot community is currently setting up automatic build i +order to test more and more configuration. All build results are +available at http://autobuild.buildroot.org[] + +A way to contribute is fixing broken builds. + +In the commit message of a patch fixing an _autobuild_, add a +reference to the _build result directory_ (the +dir+ link in the _data +column_): + +--------------------- +Fixes http://autobuild.buildroot.org/results/51000a9d4656afe9e0ea6f07b9f8ed374c2e4069 +--------------------- + +[[reporting-bugs]] +Reporting issues/bugs, get help +------------------------------- + +Before reporting some issues, please chek +xref:mailing-list-subscribe[the mailing list archive] in case someone had +already reported and fixed a similar problem. + +Whatever the way you choose to report some bugs or get help, +xref:bugtracker[opening a bug] or +xref:mailing-list-subscribe[send a mail to the mailing list], there is +a number of detail to provide in order to help people reproduce and +find a solution to the issue. + +Try to think as you would be the one who will help someone else; in +that case, what would you need? + +Here is a short list of details to provide in such case: + +* host machine (OS/release) +* version of Buildroot +* target for which the build fails +* package(s) which the build fails +* the command that fails and its output +* any information you think that may be relevant + +Additionnally, your can add the +.config+ file. + +If some of these details are too large, do not hesitate to use some +pastebin service (see +http://en.wikipedia.org/wiki/Comparison_of_pastebins[]). diff --git a/docs/manual/get-involved.txt b/docs/manual/get-involved.txt index 566516b..3a00b1e 100644 --- a/docs/manual/get-involved.txt +++ b/docs/manual/get-involved.txt @@ -61,11 +61,14 @@ http://patchwork.buildroot.org[]. All patches and comments sent through the mailing list are automatically indexed in http://patchwork.buildroot.org[patchwork]. +[[bugtracker]] Bugtracker ---------- The Buildroot bugtracker is at https://bugs.busybox.net[]. +To open a bug, see xref:reporting-bugs[]. + Buildroot wikipage ------------------ diff --git a/docs/manual/manual.txt b/docs/manual/manual.txt index 3331cbf..4032a6b 100644 --- a/docs/manual/manual.txt +++ b/docs/manual/manual.txt @@ -25,4 +25,6 @@ include::developer-guide.txt[] include::get-involved.txt[] +include::contribute.txt[] + include::appendix.txt[]