Skip to content

Commit a8cd910

Browse files
committed
update contributing
1 parent 5bda623 commit a8cd910

File tree

1 file changed

+5
-17
lines changed

1 file changed

+5
-17
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,8 @@
1-
[Poetry]: https://python-poetry.org/
2-
[Pylint]: https://www.pylint.org/
3-
[isort]: https://pycqa.github.io/isort/
4-
[mypy]: http://mypy-lang.org/
5-
[django-pytest]: https://pytest-django.readthedocs.io/en/latest/
6-
[pytest]: https://docs.pytest.org/en/stable/
7-
[Sphinx]: https://www.sphinx-doc.org/en/master/
8-
[readthedocs]: https://readthedocs.org/
9-
[me]: https://github.com/bckohan
10-
[black]: https://black.readthedocs.io/en/stable/
11-
[pyright]: https://github.com/microsoft/pyright
12-
131
# Contributing
142

153
Contributions are encouraged! Please use the issue page to submit feature requests or bug reports. Issues with attached PRs will be given priority and have a much higher likelihood of acceptance. Please also open an issue and associate it with any submitted PRs. That said, the aim is to keep this library as lightweight as possible. Only features with broad-based use cases will be considered.
164

17-
We are actively seeking additional maintainers. If you're interested, please [contact me](https://github.com/bckohan).
5+
We are actively seeking additional maintainers. If you're interested, please open an issue or [contact me](https://github.com/bckohan).
186

197
## Installation
208

@@ -26,7 +14,7 @@ poetry install
2614

2715
## Documentation
2816

29-
`django-typer` documentation is generated using [Sphinx](https://www.sphinx-doc.org/en/master/) with the [readthedocs](https://readthedocs.org/) theme. Any new feature PRs must provide updated documentation for the features added. To build the docs run doc8 to check for formatting issues then run Sphinx:
17+
`django-typer` documentation is generated using [Sphinx](https://www.sphinx-doc.org) with the [furo](https://github.com/pradyunsg/furo) theme. Any new feature PRs must provide updated documentation for the features added. To build the docs run doc8 to check for formatting issues then run Sphinx:
3018

3119
```bash
3220
cd ./doc
@@ -50,7 +38,7 @@ To run static analysis without automated fixing you can run:
5038

5139
## Running Tests
5240

53-
`django-typer` is set up to use [pytest](https://docs.pytest.org/en/stable/) to run unit tests. All the tests are housed in `tests/tests.py`. Before a PR is accepted, all tests must be passing and the code coverage must be at 100%. A small number of exempted error handling branches are acceptable.
41+
`django-typer` is set up to use [pytest](https://docs.pytest.org) to run unit tests. All the tests are housed in `tests`. Before a PR is accepted, all tests must be passing and the code coverage must be at 100%. A small number of exempted error handling branches are acceptable.
5442

5543
To run the full suite:
5644

@@ -67,6 +55,6 @@ poetry run pytest <path_to_tests_file>::ClassName::FunctionName
6755
For instance, to run all tests in BasicTests, and then just the test_call_command test you would do:
6856

6957
```shell
70-
poetry run pytest tests/tests.py::BasicTests
71-
poetry run pytest tests/tests.py::BasicTests::test_call_command
58+
poetry run pytest tests/test_basics.py::BasicTests
59+
poetry run pytest tests/test_basics.py::BasicTests::test_call_command
7260
```

0 commit comments

Comments
 (0)