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

Update contributing docs

Browse source 
Removes mentions to the old branching strategy and `gh-pages`.
This commit is contained in:
Tiago Ilieve 2015-05-02 13:21:02 -03:00
parent 3cfba08983
commit b4dd36e8cf
1 changed files with 3 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
CONTRIBUTING.rst
View file

@ -19,26 +19,16 @@ Do you want to contribute to the bootstrap-vz project? Nice! Here is the basic w
* Squash the commits if needed. For instance, it is fine if you have multiple commits describing atomic units * 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. of work, but there's no reason to have many little commits just because of corrected typos.
* Push to your fork, preferably on a topic branch. * Push to your fork, preferably on a topic branch.
From here on there are two paths to consider:
If your patch is a new feature, e.g.: plugin, provider, etc. then:
* Send a pull request to the `development` branch. It will be merged into the `master` branch when we can make
sure that the code is stable.
If it is a bug/security fix:
* Send a pull request to the `master` branch. * 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 Please try to be very descriptive about your changes when you write a pull request, stating what it does, why
it is needed, which use cases this change covers etc. it is needed, which use cases this change covers, etc.
You may be asked to rebase your work on the current branch state, so it can be merged cleanly. You may be asked to rebase your work on the current branch state, so it can be merged cleanly.
If you push a new commit to your pull request you will have to add a new comment to the PR, If you push a new commit to your pull request you will have to add a new comment to the PR,
provided that you want us notified. Github will otherwise not send a notification. provided that you want us notified. Github will otherwise not send a notification.
Be aware that your modifications need to be properly documented and pushed to the `gh-pages` branch, if they Be aware that your modifications need to be properly documented. Please take a look at the
concern anything done on `master`. Otherwise, they should be sent to the `gh-pages-dev`. `documentation section <#documentation>`__ to see how to do that.
Happy hacking! :-) Happy hacking! :-)