2014-04-08 08:30:43 -03:00
|
|
|
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
|
2014-04-08 14:59:32 -03:00
|
|
|
of work, but there's no reason to have many little commits just because of corrected typos.
|
2014-04-08 08:30:43 -03:00
|
|
|
* 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:
|
|
|
|
|
2014-04-13 22:36:30 -03:00
|
|
|
* Send a pull request to the `development` branch. It will be merged into the `master` branch when we can make
|
2014-04-08 08:30:43 -03:00
|
|
|
sure that the code is stable.
|
|
|
|
|
2014-04-13 22:36:30 -03:00
|
|
|
If it is a bug/security fix:
|
2014-04-08 08:30:43 -03:00
|
|
|
|
|
|
|
* 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
|
2014-04-08 14:59:32 -03:00
|
|
|
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
|
2014-04-13 22:36:30 -03:00
|
|
|
to your pull request, we won't be notified just by this - that will happen only if you make a new comment on
|
|
|
|
the issue.
|
2014-04-08 08:30:43 -03:00
|
|
|
|
2014-04-21 17:11:41 -03:00
|
|
|
Be aware that your modifications needs to be properly documented and pushed to the `gh-pages` branch, if they
|
|
|
|
concern anything done on `master`. Otherwise, they should be sent to the `gh-pages-dev`.
|
2014-04-08 08:30:43 -03:00
|
|
|
|
|
|
|
Happy hacking! :-)
|