From patchwork Sun May 13 10:38:21 2012 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Samuel Martin X-Patchwork-Id: 158823 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from fraxinus.osuosl.org (fraxinus.osuosl.org [140.211.166.137]) by ozlabs.org (Postfix) with ESMTP id 75251B7002 for ; Sun, 13 May 2012 20:41:42 +1000 (EST) Received: from localhost (localhost [127.0.0.1]) by fraxinus.osuosl.org (Postfix) with ESMTP id 8660610168D; Sun, 13 May 2012 10:41:41 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Received: from fraxinus.osuosl.org ([127.0.0.1]) by localhost (.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id lZhUBRlZ9avr; Sun, 13 May 2012 10:41:36 +0000 (UTC) Received: from ash.osuosl.org (ash.osuosl.org [140.211.166.34]) by fraxinus.osuosl.org (Postfix) with ESMTP id 9B8981011E1; Sun, 13 May 2012 10:40:39 +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 9D0BE8F75B for ; Sun, 13 May 2012 10:39:56 +0000 (UTC) Received: from localhost (localhost [127.0.0.1]) by whitealder.osuosl.org (Postfix) with ESMTP id 5232E81C2D for ; Sun, 13 May 2012 10:39:56 +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 wQ9-DaVCHStW for ; Sun, 13 May 2012 10:39:41 +0000 (UTC) X-Greylist: domain auto-whitelisted by SQLgrey-1.7.6 Received: from mail-wg0-f53.google.com (mail-wg0-f53.google.com [74.125.82.53]) by whitealder.osuosl.org (Postfix) with ESMTPS id 3ECAE81C2E for ; Sun, 13 May 2012 10:39:41 +0000 (UTC) Received: by mail-wg0-f53.google.com with SMTP id fm10so3721346wgb.10 for ; Sun, 13 May 2012 03:39:40 -0700 (PDT) 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=P+aEmJ2ySrQ4OUTOCQ74nRp3Vzx6uD9sWCwyokat/tA=; b=hP/ePVwmuLQ0m9jxB22P/SVPsWK3O+NbJshbiDVacMgVAVhL3nA9i5l6URe7aDgxFH ZIJLo5+H/+fcYwHoQKtxpHy6YDzlyBphIMf+Q9DZfImUBLxrmLADxq+GmjQZSeLEUqCH LvMnfy7QvYVzG7pY9+jLJKPj9relLFhi20T0fY+fRTgc55Prrpu8alanZ+jPW81F6iNI gRRw1h7quXQ4a7LdIcEmng9KDsRwZc3zceROnK2lLcjbFnItz4lNPrN03IjAnFYUekA4 5f68pb4PFdLxJ6rKz6K8C9CQ/hx58ts+ehb7f321jt0jkeuzINm3qNkWpP3dfPLmD7zn 1CAQ== Received: by 10.216.139.12 with SMTP id b12mr2826735wej.4.1336905580849; Sun, 13 May 2012 03:39:40 -0700 (PDT) Received: from localhost.localdomain (ivr94-4-82-229-165-48.fbx.proxad.net. [82.229.165.48]) by mx.google.com with ESMTPS id r2sm41271946wif.7.2012.05.13.03.39.39 (version=SSLv3 cipher=OTHER); Sun, 13 May 2012 03:39:39 -0700 (PDT) From: Samuel Martin To: buildroot@busybox.net Date: Sun, 13 May 2012 12:38:21 +0200 Message-Id: <1336905501-9757-12-git-send-email-s.martin49@gmail.com> X-Mailer: git-send-email 1.7.10.2 In-Reply-To: <1336905501-9757-1-git-send-email-s.martin49@gmail.com> References: <4FAEEFA8.2070005@mind.be> <1336905501-9757-1-git-send-email-s.martin49@gmail.com> Subject: [Buildroot] [PATCH v2 11/11] 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 From: Samuel MARTIN 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..d80e79a --- /dev/null +++ b/docs/manual/contribute.txt @@ -0,0 +1,63 @@ +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 subscribe to it, then refer to +xref:mailing-list-subscribe[]. + +Submiting patches +----------------- + +When your changes are done, and commited 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, your 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-of-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 favourite 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. + +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. diff --git a/docs/manual/manual.txt b/docs/manual/manual.txt index b23e9c1..3e7a7ef 100644 --- a/docs/manual/manual.txt +++ b/docs/manual/manual.txt @@ -27,6 +27,8 @@ include::developer-guide.txt[] include::get-involved.txt[] +include::contribute.txt[] + include::legal-notice.txt[]