Merge pull request #7 from codeship/contributing

update contributing guidelines

Author: beanieboi

CONTRIBUTING.md

@@ -0,0 +1,42 @@
+# Contributing
+In the spirit of [free software][free-sw], **everyone** is encouraged to help
+improve this project.
+
+[free-sw]: http://www.fsf.org/licensing/essays/free-sw.html
+
+Here are some ways *you* can contribute:
+
+* by using alpha, beta, and prerelease versions
+* by reporting bugs
+* by suggesting new features
+* by writing or editing documentation
+* by writing specifications
+* by writing code ( **no patch is too small** : fix typos, add comments, clean up inconsistent whitespace )
+* by refactoring code
+* by closing [issues][]
+* by reviewing patches
+
+[issues]: https://github.com/codeship/codeship-ruby/issues
+
+## Submitting an Issue
+We use the [GitHub issue tracker][issues] to track bugs and features. Before
+submitting a bug report or feature request, check to make sure it hasn't
+already been submitted. When submitting a bug report, please include a [Gist][]
+that includes a stack trace and any details that may be necessary to reproduce
+the bug, including your gem version, Ruby version, and operating system.
+Ideally, a bug report should include a pull request with failing specs.
+
+[gist]: https://gist.github.com/
+
+## Submitting a Pull Request
+1. [Fork the repository.][fork]
+2. [Create a topic branch.][branch]
+3. Implement your feature or bug fix.
+4. Add, commit, and push your changes.
+5. [Submit a pull request.][pr]
+
+[fork]: http://help.github.com/fork-a-repo/
+[branch]: http://learn.github.com/p/branching.html
+[pr]: http://help.github.com/send-pull-requests/
+
+This file was taken from https://github.com/middleman/middleman-heroku/blob/master/CONTRIBUTING.md

README.md

@@ -5,6 +5,13 @@ interact with Codeship.
 ![Build Status](https://www.codeship.io/projects/e8bf3890-ee53-0130-957a-52ea4b2c7608/status)
 
 
+## Contributing
+
+see [CONTRIBUTING.md][contributing]
+
+[contributing]: https://github.com/codeship/codeship-ruby/blob/master/CONTRIBUTING.md
+
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -46,14 +53,6 @@ Or install it yourself as:
 
 :branchnotfound, :error, :ignored, :projectnotfound, :success, :testing, :waiting, stopped, :infrastructure_failure
 
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
-
 ## Disclaimer
 
 We cannot guarantee any compatibilty with upcoming versions of this Gem.