Create CONTRIBUTING.md

CONTRIBUTING.md

@@ -0,0 +1,99 @@
+## Contributing
+
+First off, thank you for considering contributing to Hyperzsh. It's people
+like you that help make Hyperzsh into a shell that any developer would be proud to use.
+
+### 1. Where do I go from here?
+
+If you've noticed a bug or have a question see if someone else in the community has already created a ticket.
+If not, go ahead and [make one](https://github.com/tylerreckart/hyperzsh/issues/new)!
+
+### 2. Fork & create a branch
+
+If this is something you think you can fix, then
+[fork Hyperzsh](https://help.github.com/articles/fork-a-repo)
+and create a branch with a descriptive name.
+
+A good branch name would be (where issue #325 is the ticket you're working on):
+
+```sh
+git checkout -b 325-add-japanese-translations
+```
+
+### 3. Did you find a bug?
+
+* **Ensure the bug was not already reported** by [searching all
+  issues](https://github.com/tylerreckart/hyperzsh/issues?q=).
+
+* If you're unable to find an open issue addressing the problem, [open a new
+  one](https://github.com/tylerreckart/hyperzsh/issues/new).  Be sure to
+  include a **title and clear description**, as much relevant information as
+  possible, and a **code sample** or an **executable test case** demonstrating
+  the expected behavior that is not occurring.
+
+### 4. Implement your fix or feature
+
+At this point, you're ready to make your changes! Feel free to ask for help;
+everyone is a beginner at first :smile_cat:
+
+### 5. Make a Pull Request
+
+At this point, you should switch back to your master branch and make sure it's
+up to date with Hyperzsh's master branch:
+
+```sh
+git remote add upstream git@github.com:tylerreckart/hyperzsh.git
+git checkout master
+git pull upstream master
+```
+
+Then update your feature branch from your local copy of master, and push it!
+
+```sh
+git checkout 325-add-japanese-translations
+git rebase master
+git push --set-upstream origin 325-add-japanese-translations
+```
+
+Finally, go to GitHub and
+[make a Pull Request](https://help.github.com/articles/creating-a-pull-request)
+:D
+
+Travis CI will run our test suite against all supported Rails versions. We care
+about quality, so your PR won't be merged until all tests pass. It's unlikely,
+but it's possible that your changes pass tests in one Rails version but fail in
+another. In that case, you'll have to setup your development environment (as
+explained in step 3) to use the problematic Rails version, and investigate
+what's going on!
+
+### 6. Keeping your Pull Request updated
+
+If a maintainer asks you to "rebase" your PR, they're saying that a lot of code
+has changed, and that you need to update your branch so it's easier to merge.
+
+To learn more about rebasing in Git, there are a lot of
+[good](http://git-scm.com/book/en/Git-Branching-Rebasing)
+[resources](https://help.github.com/articles/interactive-rebase),
+but here's the suggested workflow:
+
+```sh
+git checkout 325-add-japanese-translations
+git pull --rebase upstream master
+git push --force-with-lease 325-add-japanese-translations
+```
+
+### 7. Merging a PR (maintainers only)
+
+A PR can only be merged into master by a maintainer if:
+
+* It is passing CI.
+* It has been approved by at least two maintainers. If it was a maintainer who
+  opened the PR, only one extra approval is needed.
+* It has no requested changes.
+* It is up to date with current master.
+
+Any maintainer is allowed to merge a PR if all of these conditions are
+met.
+
+***
+Credit to [Active Admin](https://github.com/activeadmin/activeadmin/blob/master/CONTRIBUTING.md) as their contributing guide was the outline for this one.