Skip to content

Commit f735d0c

Browse files
committed
Update CONTRIBUTING guide
1 parent b41051d commit f735d0c

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Thanks for considering to contribute to this project! Some guidelines:
88
- This package tries to be as simple as possible for the user (hide any complexity from the user). Options are only added when there is clear value to the majority of users.
99
- When issues or pull requests are not going to be resolved or merged, they should be closed as soon as possible. This is kinder than deciding this after a long period. Our issue tracker should reflect work to be done.
1010

11-
## Testing
11+
## Unit Tests
1212

1313
Make sure to install an editable version before running tests:
1414

@@ -27,9 +27,18 @@ pip install pyflakes
2727
pyflakes tests/ mkdocs_git_authors_plugin/
2828
```
2929

30-
#### Code Style
30+
## Manual testing
3131

32-
Make sure your code *roughly* follows [PEP-8](https://www.python.org/dev/peps/pep-0008/) and keeps things consistent with the rest of the code.
32+
To quickly serve a website with your latest changes to the plugin use the sites in our tests suite. For example:
3333

34-
We use google-style docstrings.
34+
```python
35+
pip install -r tests/test_requirements.txt
36+
pip install -e .
37+
mkdocs serve -f ./tests/basic_setup/mkdocs_complete_material.yml
38+
```
39+
40+
## Code Style
41+
42+
Make sure your code *roughly* follows [PEP-8](https://www.python.org/dev/peps/pep-0008/) and keeps things consistent with the rest of the code. I recommended using [black](https://github.com/psf/black) to automatically format your code.
3543

44+
We use google-style docstrings.

0 commit comments

Comments
 (0)