Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Nekokatt authored Oct 2, 2020
1 parent 345ba44 commit 5c4627b
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,21 @@ To push branches directly to the remote, you will have to name them like this:

# Nox

We have nox to help out with running pipelines locally and provides some helpfull functionality.
We have nox to help out with running pipelines locally and provides some helpful functionality.

Nox is similar to tox, but uses a pure Python configuration instead of an
INI based configuration. Nox and tox are both tools for generating virtual
environments and running commands in those environments. Examples of usage
include installing, configuring, and running flake8; running py.test, et
cetera.

You can check all the available nox commands by running `nox -l`.

Before commiting we recomend you to run `nox` to run all important pipelines and make sure the pipelines wont fail.

You may run a single pipeline with `nox -s name` or multiple pipelines with
`nox --sessions name1 name3 name9`.

# Pipelines

We have several jobs to ensure that the code is at its best that in can be.
Expand Down

0 comments on commit 5c4627b

Please sign in to comment.