Skip to content

Commit

Permalink
update contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
PedroBern committed Feb 7, 2020
1 parent 76fa1b0 commit 1b7368c
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 7 deletions.
15 changes: 12 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ pip install tox

## Running tests

After developing, the full test suite on specific versions can be evaluated by running:
After developing, you can run tests with:

```bash
# python=3.7 and django=3.0
Expand All @@ -45,19 +45,28 @@ You can specify versions, for the full list see the `tox.ini` file.
make test p=36 d=22
```

To test on all python and django versions:
Test directly with tox:

```bash
tox
```

For single file test you can run:
Single file test shortcut:

```bash
# run only tests in tests/test_register.py
make test-file f=register
```

For live testing on a django project, you can use the testproject.

Create a different virtualenv and run:

```bash
cd testproject
make install-local v=<CURRENT VERSION IN graphql_auth.__init__>
```

## Opening Pull Requests

Please fork the project and open a pull request against the master branch.
Expand Down
15 changes: 12 additions & 3 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ pip install tox

## Running tests

After developing, the full test suite on specific versions can be evaluated by running:
After developing, you can run tests with:

```bash
# python=3.7 and django=3.0
Expand All @@ -45,19 +45,28 @@ You can specify versions, for the full list see the `tox.ini` file.
make test p=36 d=22
```

To test on all python and django versions:
Test directly with tox:

```bash
tox
```

For single file test you can run:
Single file test shortcut:

```bash
# run only tests in tests/test_register.py
make test-file f=register
```

For live testing on a django project, you can use the testproject.

Create a different virtualenv and run:

```bash
cd testproject
make install-local v=<CURRENT VERSION IN graphql_auth.__init__>
```

## Opening Pull Requests

Please fork the project and open a pull request against the master branch.
Expand Down
2 changes: 1 addition & 1 deletion docs/pre_build.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""
- get class names and docstrings as context variables into the docs
- copy [CONTRIBUTORS, CHANGES] files to the docs dir
- copy [CONTRIBUTORS, CHANGES, CONTRIBUTING] files to the docs dir
"""

import os
Expand Down

0 comments on commit 1b7368c

Please sign in to comment.