diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 58c7e95..eeac5f3 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -8,7 +8,7 @@ Changelog - Support for Python 3.6 - Minor refactors related to code style -- Improved integration with [codeclimate](https://codeclimate.com/) +- Improved integration with `codeclimate `_ 1.5.0 (2016-10-30) ------------------ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a1f0ac0..ee2573f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,26 +10,6 @@ If you have any enhancement suggestions or find a bug, please: 3. Do your magic -4. Please, [PEP8](https://www.python.org/dev/peps/pep-0008/) and [test your](#running-tests) code +4. Please, [PEP8](https://www.python.org/dev/peps/pep-0008/) and [test your](README.rst#running-tests) code 5. All good? Make a [pull request](https://github.com/pv8/noipy/pulls) - -## Running tests - -Install tests dependencies: - -```bash -$ pip install -r requirements-dev.txt -``` - -Test the code against all supported Python versions and check it against **PEP8** with ``tox``: - -```bash -$ tox -``` - -Check **PEP8** only: - -```bash -$ tox -e pep8 -``` diff --git a/README.rst b/README.rst index 2393ad4..55a6d77 100644 --- a/README.rst +++ b/README.rst @@ -120,21 +120,6 @@ And type username and password when required. `Base64 `_ method and is not actually *encrypted*! - -Contributing ------------- - -Improvements & Troubleshooting -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -If you have any enhancement suggestions or find a bug, please: - -#. Open an `issue `_ -#. `Fork `_ the project -#. Do your magic -#. Please, `PEP8 `_ and test your code -#. Is everything working? Send a `pull request `_ - Running tests ~~~~~~~~~~~~~ @@ -152,6 +137,12 @@ Test the code against all supported Python versions and check it against **PEP8* $ tox +Check **PEP8** only: + +.. code-block:: bash + + $ tox -e pep8 + Copyright & License -------------------