aurora-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From wfar...@apache.org
Subject aurora git commit: Clarify the commit process for new contributors.
Date Wed, 11 Nov 2015 16:22:47 GMT
Repository: aurora
Updated Branches:
  refs/heads/master 872aa79d1 -> 95daf471f


Clarify the commit process for new contributors.

Reviewed at https://reviews.apache.org/r/40161/


Project: http://git-wip-us.apache.org/repos/asf/aurora/repo
Commit: http://git-wip-us.apache.org/repos/asf/aurora/commit/95daf471
Tree: http://git-wip-us.apache.org/repos/asf/aurora/tree/95daf471
Diff: http://git-wip-us.apache.org/repos/asf/aurora/diff/95daf471

Branch: refs/heads/master
Commit: 95daf471f1d394d76e2d1f1d2bab7e4fdcaff860
Parents: 872aa79
Author: John Sirois <john.sirois@gmail.com>
Authored: Wed Nov 11 08:22:40 2015 -0800
Committer: Bill Farner <wfarner@apache.org>
Committed: Wed Nov 11 08:22:40 2015 -0800

----------------------------------------------------------------------
 CONTRIBUTING.md | 41 +++++++++++++++++++++++------------------
 1 file changed, 23 insertions(+), 18 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/aurora/blob/95daf471/CONTRIBUTING.md
----------------------------------------------------------------------
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 5cdb4b1..59ac829 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,5 +1,5 @@
-Get the Source Code
--------------------
+## Get the Source Code
+
 First things first, you'll need the source! The Aurora source is available from Apache git:
 
     git clone https://git-wip-us.apache.org/repos/asf/aurora
@@ -12,24 +12,24 @@ both languages.
 - [Java Style Guide](https://github.com/twitter/commons/blob/master/src/java/com/twitter/common/styleguide.md)
 - [Python Style Guide](https://github.com/twitter/commons/blob/master/src/python/twitter/common/styleguide.md)
 
-Find Something to Do
---------------------
+## Find Something to Do
+
 There are issues in [Jira](https://issues.apache.org/jira/browse/AURORA) with the
 ["newbie" label](https://issues.apache.org/jira/issues/?jql=project%20%3D%20AURORA%20AND%20labels%20%3D%20newbie%20and%20resolution%3Dunresolved)
 that are good starting places for new Aurora contributors; pick one of these and dive in!
Once
 you've got a patch, the next step is to post a review.
 
-Getting your ReviewBoard Account
---------------------------------
+## Getting your ReviewBoard Account
+
 Go to https://reviews.apache.org and create an account.
 
-Setting up your ReviewBoard Environment
----------------------------------------
+## Setting up your ReviewBoard Environment
+
 Run `./rbt status`. The first time this runs it will bootstrap and you will be asked to login.
 Subsequent runs will cache your login credentials.
 
-Submitting a Patch for Review
------------------------------
+## Submitting a Patch for Review
+
 Post a review with `rbt`, fill out the fields in your browser and hit Publish.
 
     ./rbt post -o
@@ -39,15 +39,20 @@ Joshua Cohen (jcohen). They will take care of finding an appropriate reviewer
fo
 
 Once you've done this, you probably want to mark the associated Jira issue as Reviewable.
 
-Updating an Existing Review
----------------------------
+## Updating an Existing Review
+
 Incorporate review feedback, make some more commits, update your existing review, fill out
the
 fields in your browser and hit Publish.
 
     ./rbt post -o -r <RB_ID>
 
-Merging Your Own Review (Committers)
-------------------------------------
+## Getting Your Review Merged
+
+If you're not an Aurora committer, one of the committers will merge your change in as described
+below. Generally, the last reviewer to give the review a 'Ship It!' will be responsible.
+
+### Merging Your Own Review (Committers)
+
 Once you have shipits from the right committers, merge your changes in a single commit and
mark
 the review as submitted. The typical workflow is:
 
@@ -62,8 +67,8 @@ the review as submitted. The typical workflow is:
 Note that even if you're developing using feature branches you will not use `git merge` -
each
 commit will be an atomic change accompanied by a ReviewBoard entry.
 
-Merging Someone Else's Review
------------------------------
+### Merging Someone Else's Review
+
 Sometimes you'll need to merge someone else's RB. The typical workflow for this is
 
     git checkout master
@@ -72,8 +77,8 @@ Sometimes you'll need to merge someone else's RB. The typical workflow for
this
     git show master  # Verify everything looks sane, author is correct
     git push origin master
 
-Cleaning Up
------------
+## Cleaning Up
+
 Your patch has landed, congratulations! The last thing you'll want to do before moving on
to your
 next fix is to clean up your Jira and Reviewboard. The former of which should be marked as
 "Resolved" while the latter should be marked as "Submitted".


Mime
View raw message