File tree 1 file changed +24
-0
lines changed
1 file changed +24
-0
lines changed Original file line number Diff line number Diff line change @@ -4,6 +4,8 @@ Contributions (pull requests) are very welcome! Here's how to get started.
4
4
5
5
---
6
6
7
+ ** Getting started**
8
+
7
9
First fork the library on GitHub.
8
10
9
11
Then clone and install the library in development mode:
@@ -23,6 +25,10 @@ pre-commit install
23
25
24
26
These hooks use Black and isort to format the code, and flake8 to lint it.
25
27
28
+ ---
29
+
30
+ ** If you're making changes to the code:**
31
+
26
32
Now make your changes. Make sure to include additional tests if necessary.
27
33
28
34
Next verify the tests all pass:
@@ -39,3 +45,21 @@ git push
39
45
```
40
46
41
47
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.
You can’t perform that action at this time.
0 commit comments