Merge pull request #68 from myhro/new-contributing

Add contribution guidelines

CONTRIBUTING.md

@@ -0,0 +1,32 @@
+Contributing
+============
+
+Do you want to contribute to the bootstrap-vz project? Nice! Here is the basic workflow:
+
+* Fork this repository.
+* Make any changes you want/need.
+* Commit your changes.
+* Squash the commits if needed. For instance, it is fine if you have multiple commits describing atomic units
+of work, but there's no reason to have many little commits just because of corrected typos.
+* Push to your fork, preferable on a topic branch.
+
+By this moment, there are two paths that you have to consider:
+
+If you patch is a new feature, e.g.: plugin, provider, etc. then:
+
+* Send a pull request to the `development` branch. It will be merged to the `master` branch when we can make
+sure that the code is stable.
+
+If it as a bug/security fix:
+
+* Send a pull request to the `master` branch.
+
+Please try to be very descriptive about your changes when you write a pull request, stating what it does, why
+it is needed, what use cases do you think it would be useful, etc. You could as well be asked to rebase your
+work on the current branch state, so it can be merged cleanly. Also, be in mind that if you push a new commit
+to your pull request, we won't be notified just by this - that will happen only if you make a comment on the
+issue.
+
+Be aware that your modifications needs to be properly documented and pushed to the `gh-pages` branch.
+
+Happy hacking! :-)

README.md

@@ -22,3 +22,10 @@ and learn [how you create a manifest](http://andsens.github.io/bootstrap-vz/mani
 Developers
 ----------
 The API documentation can be found at [bootstrap-vz.readthedocs.org](http://bootstrap-vz.readthedocs.org).
+
+Contributing
+------------
+
+Contribution guidelines are described on the [CONTRIBUTING](CONTRIBUTING.md) file.
+There's also a [topic on the documentation](http://andsens.github.io/bootstrap-vz/development.html#coding_style)
+regarding the coding style.