diff --git a/AUTHORS.rst b/AUTHORS.rst index 14325538..652691eb 100644 --- a/AUTHORS.rst +++ b/AUTHORS.rst @@ -2,4 +2,5 @@ Authors ======= -* Nicolas Beltran - https://blog.ionelmc.ro +* Nicolas Beltran - https://github.com/velezbeltran +* Alessandro Grande - https://github.com/aagrande diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 8b227742..04030d86 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -83,3 +83,18 @@ To run a subset of tests:: To run all the test environments in *parallel*:: tox -p auto + +Before committing it is important to run pre-commit (github will check that you +did). Running tox does this but if you want to dot it manually here is a short blurb +of what is and how it works. +`pre-commit` is tool that runs checks on your code before you commit it. It is great! +Here is the workflow on how to use it: +Assume there are files `file.txt` and `scripty.py`. Then the workflows is:: + + git add file.txt + git add scripty.py + pre-commit + ... [fix all of the things that can't be automatically fixed ] ... + git add file.txt + git add script.txt + git commit -m "some message" diff --git a/README.rst b/README.rst index 54f2e825..9fd6f443 100644 --- a/README.rst +++ b/README.rst @@ -32,7 +32,7 @@ To run all the tests run:: tox However, this is usually excessive so it is easier to use pytest with -your environment. When you push tox will run automatically. +your environment. When you push tox will run automatically. Note, to combine the coverage data from all the tox environments run: @@ -53,7 +53,7 @@ Note, to combine the coverage data from all the tox environments run: -Before committing it is important to run pre-commit (github will check that you +Before committing it is important to run pre-commit (github will check that you did). `pre-commit` will run automatically as a hook so that to commit things need to adhere to the linter. To make sure this is the case you can use the following work-stream. Assume there are files `file.txt` and `scripty.py`. Then the workflows is:: @@ -66,7 +66,7 @@ work-stream. Assume there are files `file.txt` and `scripty.py`. Then the workfl git add script.txt git commit -m "some message" - + Note, to combine the coverage data from all the tox environments run: