From e72337b5d889610df0f7ebede80c2ecbacf600dd Mon Sep 17 00:00:00 2001 From: Jerry Cheung Date: Thu, 14 Feb 2013 12:49:59 -0800 Subject: add contribution guidelines --- CONTRIBUTING.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 CONTRIBUTING.md (limited to 'CONTRIBUTING.md') diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..a39f73f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,27 @@ +## Note on Patches/Pull Requests + +Thanks for taking the time to contribute back! To make it easier for us to +review your changes, try to follow these guidelines: + +* Keep changesets small and on topic. Itching to refactor or clean something + up? Do it in a separate branch. +* Stay consistent with existing code conventions. +* Break changes into smaller logical commits. + +To propose a change: + +* [Fork the project.](https://help.github.com/articles/fork-a-repo) +* Make your feature addition or bug fix. +* Add tests for it. This is important so I don't break it in a future version unintentionally. +* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull) +* [Send me a pull request](https://help.github.com/articles/using-pull-requests). Bonus points for topic branches. +* [Check that your pull request passes the build](https://travis-ci.org/intridea/hashie/pull_requests). + +## Bug triage + +Have a problem? File an [issue here](https://github.com/intridea/hashie/issues). + +To make bug squashing easier, include the following in your issue: + +* What version of hashie are you using? +* Is it still a problem in master? \ No newline at end of file -- cgit v1.2.1