From 59109ce59d7cba4a81341241b6c67ef02ffe5000 Mon Sep 17 00:00:00 2001 From: Nihad Abbasov Date: Mon, 15 Dec 2014 05:19:14 +0400 Subject: [PATCH] add CONTRIBUTING.md --- CONTRIBUTING.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..0151e0a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,30 @@ +# How to contribute + +In the spirit of open source software, **everyone** is encouraged to help +improve this project. + +## Your Pull Request + +To make it easy to review and understand your change please keep the following +things in mind before submitting your pull request: + +* Work on the latest possible state of **ginatra/master** +* Create a branch which is dedicated to your change +* Test your changes before creating a pull request (`bundle exec rake`) +* If possible write a test case which confirms your change +* Don't mix several features or bug-fixes in one pull request +* Create a meaningful commit message +* Explain your change (i.e. with a link to the issue you are fixing) +* Keep it simple: don't overcomplicate things and add extra dependencies unless + you have a *special* reason + +**IMPORTANT**: + +Before you start working on a larger contribution, you should get in touch first +through the issue tracker with your idea so that the project's developers can +help out and possibly guide you. Coordinating up front makes it much easier to +avoid frustration later on. + +# Thank you + +Each contribution is extremely helpful - thank you!