Skip to content

Commit cec091c

Browse files
Update CONTRIBUTING.md
1 parent 997d0e3 commit cec091c

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

CONTRIBUTING.md

+24
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ Contributions (pull requests) are very welcome! Here's how to get started.
44

55
---
66

7+
**Getting started**
8+
79
First fork the library on GitHub.
810

911
Then clone and install the library in development mode:
@@ -23,6 +25,10 @@ pre-commit install
2325

2426
These hooks use Black and isort to format the code, and flake8 to lint it.
2527

28+
---
29+
30+
**If you're making changes to the code:**
31+
2632
Now make your changes. Make sure to include additional tests if necessary.
2733

2834
Next verify the tests all pass:
@@ -39,3 +45,21 @@ git push
3945
```
4046

4147
Finally, open a pull request on GitHub!
48+
49+
---
50+
51+
**If you're making changes to the documentation:**
52+
53+
Make your changes. You can then build the documentation by doing
54+
55+
```bash
56+
pip install -r docs/requirements.txt
57+
mkdocs serve
58+
```
59+
Then doing `Control-C`, and running:
60+
```
61+
mkdocs serve
62+
```
63+
(So you run `mkdocs serve` twice.)
64+
65+
You can then see your local copy of the documentation by navigating to `localhost:8000` in a web browser.

0 commit comments

Comments
 (0)