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: CONTRIBUTING.md
+13-4Lines changed: 13 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ Thanks for considering to contribute to this project! Some guidelines:
8
8
- 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.
9
9
- 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.
10
10
11
-
## Testing
11
+
## Unit Tests
12
12
13
13
Make sure to install an editable version before running tests:
14
14
@@ -27,9 +27,18 @@ pip install pyflakes
27
27
pyflakes tests/ mkdocs_git_authors_plugin/
28
28
```
29
29
30
-
#### Code Style
30
+
##Manual testing
31
31
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:
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.
0 commit comments