CONTRIBUTING.md in pwwka-0.4.2 vs CONTRIBUTING.md in pwwka-0.5.0

- old
+ new

@@ -1,15 +1,23 @@ +# Contributing +Thanks for using and improving *pwwka*! If you'd like to help out, check out [the project's issues list](https://github.com/stitchfix/pwwka/issues) for ideas on what could be improved. -## Contributing - We're actively using Pwwka in production here at [Stitch Fix](http://technology.stitchfix.com/) and look forward to seeing Pwwka grow and improve with your help. Contributions are warmly welcomed. -To contribute, -1. make a fork of the project -2. write some code (with tests please!) -3. open a Pull Request -4. bask in the warm fuzzy Open Source hug from us +If there's an idea you'd like to propose, or a design change, feel free to file a new issue or send a pull request: -## Testing -<a name="testing"></a> +1. [Fork][fork] the repo. +1. [Create a topic branch.][branch] +1. Write tests. +1. Implement your feature or fix bug. +1. Add, commit, and push your changes. +1. [Submit a pull request.][pr] -You must be running RabbitMQ locally on the default port in order for the tests to work. +[fork]: https://help.github.com/articles/fork-a-repo/ +[branch]: https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/ +[pr]: https://help.github.com/articles/using-pull-requests/ + +## General Guidelines + +* You must be running RabbitMQ locally on the default port in order for the tests to work. +* When in doubt, test it. If you can't test it, re-think what you are doing. +* Code formatting and internal application architecture should be consistent.