From 26c38ca0504cf16dbfdcbb15e04439138d5b8727 Mon Sep 17 00:00:00 2001 From: Tom Krouper Date: Mon, 23 Jan 2017 12:54:33 -0800 Subject: [PATCH] CONTRIBUTING.md added --- CONTRIBUTING.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..3a78dd9 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,26 @@ +## Contributing + +[fork]: https://github.com/github/puppet-orchestrator-for-mysql/fork +[pr]: https://github.com/github/puppet-orchestrator-for-mysql/compare + +Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great. + +## Submitting a pull request + +0. [Fork][fork] and clone the repository +0. Create a new branch: `git checkout -b my-branch-name` +0. Make your change, add tests, and make sure the tests still pass +0. Push to your fork and [submit a pull request][pr] +0. Pat your self on the back and wait for your pull request to be reviewed and merged. + +Here are a few things you can do that will increase the likelihood of your pull request being accepted: + +- Write tests. +- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests. +- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). + +## Resources + +- [Contributing to Open Source on GitHub](https://guides.github.com/activities/contributing-to-open-source/) +- [Using Pull Requests](https://help.github.com/articles/using-pull-requests/) +- [GitHub Help](https://help.github.com)