Updating information to reflect our new practices and our move to using the Github workflow for the project. (#102)
* Updating or documentation to reflect our new practices and our move to using the Github workflow for the project.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 76d4cef..85a1408 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -14,39 +14,26 @@
## 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)
+There are issues in [Github](https://github.com/apache/aurora/issues) with the
+["good first issue" label](https://github.com/apache/aurora/issues?q=is%3Aissue+label%3A%22good+first+issue%22+is%3Aopen)
that are good starting places for new Aurora contributors; pick one of these and dive in! To assign
-a task to yourself, first ask for your JIRA id to be whitelisted by either asking in IRC/Slack or by
-emailing dev@apache.aurora.org. Once your JIRA account has been whitelisted you can assign tickets
-to yourself. The next step is to prepare your patch and finally post it for review.
+a task to yourself, you may chime in on the issue discussion and ask one of the maintainers
+to assign the issue to you, drop us a message on our Slack channel, or
+email us at dev@apache.aurora.org.
-## Getting your ReviewBoard Account
+The next step is to prepare your patch and then send us a Pull Request via the Github Web UI.
-Go to https://reviews.apache.org and create an account.
+## Submitting a Pull Request
-## Setting up your ReviewBoard Environment
+Follow the instructions outlined in the
+[Github Documentation](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request)
-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.
+If possible, make a link to the issue this PR is solving by adding the `#` followed by the number
+of the issue it is addressing.
-## Submitting a Patch for Review
-
-Post a review with `rbt`, fill out the fields in your browser and hit Publish.
-
- ./rbt post -o
-
-If you're unsure about who to add as a reviewer, you can default to adding Stephan Erb (StephanErb) and
-Renan DelValle (rdelvalle). They will take care of finding an appropriate reviewer for the patch.
-
-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>
+If you're unsure about who to add as a reviewer, you can default to adding Stephan Erb (StephanErb),
+Mauricio Garavaglia (mauri), or Renan DelValle (ridv).
+They will take care of finding an appropriate reviewer for the patch.
## Getting Your Review Merged
@@ -55,32 +42,17 @@
### 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:
+Submit a Pull Request against the master branch and click on squash and merge the PR via
+the Github Web UI.
- 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
+Sometimes you'll need to merge someone else's PR. Use Github's Web UI to do this using the
+squash and merge strategy.
- 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
-Note for committers: while we generally use the commit message generated by `./rbt patch` some
-changes are often required:
+Note for committers: some changes are often required to the commit message:
1. Ensure the the commit message does not exceed 100 characters per line.
2. Remove the "Testing Done" section. It's generally redundant (can be seen by checking the linked
@@ -89,5 +61,6 @@
## 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".
+next fix is to clean up. You may delete the branch that served as the basis
+for the PR and if the PR addresses a specific Github Issue, this issue should be closed and be tagged
+with the version on which the fix landed.
diff --git a/README.md b/README.md
index 48c59eb..ccb432c 100644
--- a/README.md
+++ b/README.md
@@ -71,10 +71,11 @@
- [Uber](https://www.uber.com)
## Getting Help
-If you have questions that aren't answered in our [documentation](https://aurora.apache.org/documentation/latest/), you can reach out to one of our [mailing lists](https://aurora.apache.org/community/). We're also often available in IRC: #aurora on
-[irc.freenode.net](http://webchat.freenode.net/?channels=#aurora).
+If you have questions that aren't answered in our [documentation](https://aurora.apache.org/documentation/latest/), you can reach out to one of our [mailing lists](https://aurora.apache.org/community/).
+We're also often available in Slack: #aurora on [mesos.slack.com](http://mesos.slack.com).
+Invites to our slack channel may be requested via [mesos-slackin.herokuapp.com](https://mesos-slackin.herokuapp.com/)
-You can also file bugs/issues in our [JIRA queue](http://issues.apache.org/jira/browse/AURORA).
+You can also file bugs/issues in our [Github](https://github.com/apache/aurora/issues) repo.
## License
diff --git a/docs/README.md b/docs/README.md
index 8bf936d..481497c 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -5,7 +5,8 @@
fault-tolerance, and resource isolation.
We encourage you to ask questions on the [Aurora user list](http://aurora.apache.org/community/) or
-the `#aurora` IRC channel on `irc.freenode.net`.
+the `#aurora` Slack channel on `mesos.slack.com`.
+An invite can be obtained via `mesos-slackin.herokuapp.com`.
## Getting Started
