kevinheyer/bootstrap-vz
1
0
Fork 0
mirror of https://github.com/kevingruesser/bootstrap-vz.git synced 2025-08-24 15:36:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add contribution guidelines

Browse source 
I've added a _Contributing_ section to the README and a [CONTRIBUTING
file](https://github.com/blog/1184-contributing-guidelines). I do not
expected for these changes to be merged right away, as they can be seen
as a draft from what I've observed in the past weeks. The intention here
is not only help the developers that are new to the project, but also
make it easier for Anders to deal with new patches.
This commit is contained in:
Tiago Ilieve 2014-04-08 08:30:43 -03:00
parent 399dfa3fa0
commit 3ee994d9bf
2 changed files with 36 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,29 @@
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 theres no reason to have many 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.
Be aware that your modifications needs to be properly documented and pushed to the `gh-pages` branch.
Happy hacking! :-)

7
README.md
View file

@ -22,3 +22,10 @@ and learn [how you create a manifest](http://andsens.github.io/bootstrap-vz/mani
Developers Developers
---------- ----------
The API documentation can be found at [bootstrap-vz.readthedocs.org](http://bootstrap-vz.readthedocs.org). 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.