Skip to content

Commit ec014ba

Browse files
Implemented changes to contributing guidelines
1 parent 030a08f commit ec014ba

1 file changed

Lines changed: 4 additions & 6 deletions

File tree

.github/CONTRIBUTING

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,6 @@ We do our best to maintain Turftopic, and any help or suggestions are most welco
1010
## We Develop with Github
1111
We use github to host code, to track issues and feature requests, as well as accept pull requests.
1212

13-
## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
14-
Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests:
15-
1613
## Setting up your environment
1714

1815
#### Installing dependencies
@@ -29,20 +26,21 @@ We use black and isort on all files and encourage you to do the same. Code forma
2926
```bash
3027
pip install black isort
3128

32-
python3 -m black turftopic/
33-
python3 -m isort turftopic/
29+
python -m black turftopic/
30+
python -m isort turftopic/
3431
```
3532

3633
#### Running tests
3734

3835
To run tests locally run:
3936

4037
```bash
41-
python3 -m pytest tests/
38+
python -m pytest tests/
4239
```
4340

4441
#### Running documentation
4542

43+
Turftopic uses [mkdocs](https://www.mkdocs.org/) and [mkdocs-material](https://squidfunk.github.io/mkdocs-material/) to generate documentation.
4644
You can build the documentation and host it locally by running:
4745

4846
```bash

0 commit comments

Comments
 (0)