diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c99d593..8c147d4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,17 +3,18 @@ Contributing Do you want to contribute to the bootstrap-vz project? Nice! Here is the basic workflow: +* Read the [development guidelines](http://bootstrap-vz.readthedocs.org/en/master/guidelines.html) * Fork this repository. * Make any changes you want/need. * Check the coding style of your changes using [tox](http://tox.readthedocs.org/) by running `tox -e flake8` -and fix any warnings that may appear. -This check will be repeated by [Travis CI](https://travis-ci.org/andsens/bootstrap-vz) -once you send a pull request, so it's better if you check this beforehand. + and fix any warnings that may appear. + This check will be repeated by [Travis CI](https://travis-ci.org/andsens/bootstrap-vz) + once you send a pull request, so it's better if you check this beforehand. * If the change is significant (e.g. a new plugin, manifest setting or security fix) -add your name and contribution to the [changelog](CHANGELOG.md). + add your name and contribution to the [changelog](CHANGELOG.md). * 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. + 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. From here on there are two paths to consider: @@ -21,7 +22,7 @@ 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. + sure that the code is stable. If it is a bug/security fix: diff --git a/README.md b/README.md index bd72479..71ea499 100644 --- a/README.md +++ b/README.md @@ -20,11 +20,12 @@ 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). +The API documentation, development guidelines and an explanation of bootstrap-vz internals +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) +Contribution guidelines are described on the [CONTRIBUTING](CONTRIBUTING.md) file. There's also a +[topic on the documentation](http://bootstrap-vz.readthedocs.org/en/development/guidelines.html#coding-style) regarding the coding style.