You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING
+4-6Lines changed: 4 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -10,9 +10,6 @@ We do our best to maintain Turftopic, and any help or suggestions are most welco
10
10
## We Develop with Github
11
11
We use github to host code, to track issues and feature requests, as well as accept pull requests.
12
12
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
-
16
13
## Setting up your environment
17
14
18
15
#### Installing dependencies
@@ -29,20 +26,21 @@ We use black and isort on all files and encourage you to do the same. Code forma
29
26
```bash
30
27
pip install black isort
31
28
32
-
python3 -m black turftopic/
33
-
python3 -m isort turftopic/
29
+
python -m black turftopic/
30
+
python -m isort turftopic/
34
31
```
35
32
36
33
#### Running tests
37
34
38
35
To run tests locally run:
39
36
40
37
```bash
41
-
python3 -m pytest tests/
38
+
python -m pytest tests/
42
39
```
43
40
44
41
#### Running documentation
45
42
43
+
Turftopic uses [mkdocs](https://www.mkdocs.org/) and [mkdocs-material](https://squidfunk.github.io/mkdocs-material/) to generate documentation.
46
44
You can build the documentation and host it locally by running:
0 commit comments