From f725e16aee876240615d073e61dc0cfd19b99e0e Mon Sep 17 00:00:00 2001 From: Dave Shawley Date: Thu, 16 Sep 2021 09:27:58 -0400 Subject: [PATCH 1/2] Increase visibility of docs/contributing.rst. --- docs/contributing.rst => CONTRIBUTING | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) rename docs/contributing.rst => CONTRIBUTING (84%) diff --git a/docs/contributing.rst b/CONTRIBUTING similarity index 84% rename from docs/contributing.rst rename to CONTRIBUTING index 82ef9b1..4ad338a 100644 --- a/docs/contributing.rst +++ b/CONTRIBUTING @@ -14,7 +14,7 @@ environment for your endeavors:: $ python3 -m venv env Don't worry about writing code against previous versions of Python unless -you you don't have a choice. That is why we run our tests through `tox`_. +you you don't have a choice. That is why we run our tests using tox. The next step is to install the development tools that this project uses. These are listed in *requires/development.txt*:: @@ -43,10 +43,10 @@ For other commands, *setup.py* is the swiss-army knife in your development tool chest. It provides the following commands: **./setup.py build_sphinx** - Generate the documentation using `sphinx`_. + Generate the documentation using sphinx. **./setup.py flake8** - Run `flake8`_ over the code and report style violations. + Run flake8 over the code and report style violations. If any of the preceding commands give you problems, then you will have to fix them **before** your pull request will be accepted. @@ -59,8 +59,8 @@ unittest runner:: $ python -m unittest tests That's the quick way to run tests. The slightly longer way is to run -the `tox`_ utility. It will run the test suite against all of the supported -python versions in parallel. This is essentially what Travis-CI +the tox utility. It will run the test suite against all of the supported +python versions in parallel. This is essentially what our CI pipeline will do when you issue a pull request anyway:: $ tox -p auto @@ -84,9 +84,5 @@ posterity. You've probably already cloned this repository and created a new branch. If you haven't, then checkout what you have as a branch and roll back *master* to where you found it. Then push your repository up to github and issue a pull request. Describe your changes in the request, -if Travis isn't too annoyed someone will review it, and eventually merge +if CI pipeline passes then someone will review it, and eventually merge it back. - -.. _flake8: https://flake8.pycqa.org/ -.. _sphinx: https://sphinx-doc.org/ -.. _tox: https://tox.readthedocs.io/ From 13d90516ab51df18252de3e0e0bc4d471428a79e Mon Sep 17 00:00:00 2001 From: Dave Shawley Date: Thu, 16 Sep 2021 09:29:04 -0400 Subject: [PATCH 2/2] Stitch CONTRIBUTING back into the doc set. --- docs/contributing.rst | 1 + 1 file changed, 1 insertion(+) create mode 100644 docs/contributing.rst diff --git a/docs/contributing.rst b/docs/contributing.rst new file mode 100644 index 0000000..0e5a08e --- /dev/null +++ b/docs/contributing.rst @@ -0,0 +1 @@ +.. include:: ../CONTRIBUTING