You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@aurora.apache.org by wf...@apache.org on 2015/01/27 20:09:42 UTC
incubator-aurora git commit: Add CONTRIBUTING.md so github shows a
link to it before opening a PR.
Repository: incubator-aurora
Updated Branches:
refs/heads/master 08ef58e2d -> 57a8f4fd9
Add CONTRIBUTING.md so github shows a link to it before opening a PR.
Reviewed at https://reviews.apache.org/r/30249/
Project: http://git-wip-us.apache.org/repos/asf/incubator-aurora/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-aurora/commit/57a8f4fd
Tree: http://git-wip-us.apache.org/repos/asf/incubator-aurora/tree/57a8f4fd
Diff: http://git-wip-us.apache.org/repos/asf/incubator-aurora/diff/57a8f4fd
Branch: refs/heads/master
Commit: 57a8f4fd9f57e14f231ec4bcb6eca634f48d3046
Parents: 08ef58e
Author: Jeffrey Schroeder <je...@computer.org>
Authored: Tue Jan 27 11:08:56 2015 -0800
Committer: Bill Farner <wf...@apache.org>
Committed: Tue Jan 27 11:08:56 2015 -0800
----------------------------------------------------------------------
CONTRIBUTING.md | 76 +++++++++++++++++++++++++++++++++++++++++++++++
docs/README.md | 4 +--
docs/contributing.md | 76 -----------------------------------------------
3 files changed, 78 insertions(+), 78 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-aurora/blob/57a8f4fd/CONTRIBUTING.md
----------------------------------------------------------------------
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..48d3dde
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,76 @@
+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/incubator-aurora
+
+Read the Style Guides
+---------------------
+Aurora's codebase is primarily Java and Python and conforms to the Twitter Commons styleguides for
+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
+--------------------
+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
+--------------------------------
+Go to https://reviews.apache.org and create an account.
+
+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
+-----------------------------
+Post a review with `rbt`, fill out the fields in your browser and hit Publish.
+
+ ./rbt post -o
+
+Once you've done this, you probably want to mark the associated Jira issue as Reviewable.
+
+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)
+------------------------------------
+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:
+
+ git checkout master
+ git pull origin master
+ ./rbt patch -c <RB_ID> # Verify the automatically-generated commit message looks sane,
+ # editing if necessary.
+ git show master # Verify everything looks sane
+ git push origin master
+ ./rbt close <RB_ID>
+
+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
+-----------------------------
+Sometimes you'll need to merge someone else's RB. The typical workflow for this is
+
+ git checkout master
+ git pull origin master
+ ./rbt patch -c <RB_ID>
+ git show master # Verify everything looks sane, author is correct
+ git push origin master
+
+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".
http://git-wip-us.apache.org/repos/asf/incubator-aurora/blob/57a8f4fd/docs/README.md
----------------------------------------------------------------------
diff --git a/docs/README.md b/docs/README.md
index 4889b3f..7fb89a3 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -27,7 +27,7 @@ This documentation is a work in progress, and we encourage you to ask questions
* [Generating test resources](test-resource-generation.md)
## Developers
- * [Contributing to the project](contributing.md)
+ * [Contributing to the project](CONTRIBUTING.md)
* [Developing the Aurora Scheduler](developing-aurora-scheduler.md)
* [Developing the Aurora Client](developing-aurora-client.md)
- * [Committers Guide](committers.md)
\ No newline at end of file
+ * [Committers Guide](committers.md)
http://git-wip-us.apache.org/repos/asf/incubator-aurora/blob/57a8f4fd/docs/contributing.md
----------------------------------------------------------------------
diff --git a/docs/contributing.md b/docs/contributing.md
deleted file mode 100644
index 48d3dde..0000000
--- a/docs/contributing.md
+++ /dev/null
@@ -1,76 +0,0 @@
-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/incubator-aurora
-
-Read the Style Guides
----------------------
-Aurora's codebase is primarily Java and Python and conforms to the Twitter Commons styleguides for
-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
---------------------
-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
---------------------------------
-Go to https://reviews.apache.org and create an account.
-
-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
------------------------------
-Post a review with `rbt`, fill out the fields in your browser and hit Publish.
-
- ./rbt post -o
-
-Once you've done this, you probably want to mark the associated Jira issue as Reviewable.
-
-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)
-------------------------------------
-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:
-
- git checkout master
- git pull origin master
- ./rbt patch -c <RB_ID> # Verify the automatically-generated commit message looks sane,
- # editing if necessary.
- git show master # Verify everything looks sane
- git push origin master
- ./rbt close <RB_ID>
-
-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
------------------------------
-Sometimes you'll need to merge someone else's RB. The typical workflow for this is
-
- git checkout master
- git pull origin master
- ./rbt patch -c <RB_ID>
- git show master # Verify everything looks sane, author is correct
- git push origin master
-
-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".