github/sprockets.mixins.mediatype
1
0
Fork 0
mirror of https://github.com/sprockets/sprockets.mixins.mediatype.git synced 2024-11-21 19:28:38 +00:00
Code Issues Projects Releases Packages Wiki Activity

Increase visibility of docs/contributing.rst.

Browse source
This commit is contained in:
Dave Shawley 2021-09-16 09:27:58 -04:00
parent d1a4511955
commit f725e16aee
No known key found for this signature in database
GPG key ID: F41A8A99298F8EED
1 changed files with 6 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
docs/contributing.rst → CONTRIBUTING
View file

@ -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/