@@ -3,15 +3,13 @@ Contributing guidelines
33
44Issues
55------
6- ** Only report issues for _ pdoc3 _ package on PyPI. **
7- If your issue pertains to older _ pdoc _ package (on PyPI) ,
8- report the issue [ here] or ... just stop using it .
6+ Only report issues for ** PyPI package _ pdoc3 _ ** .
7+ If your issue pertains to the other PyPI package _ pdoc _ ,
8+ report its issue [ here] ( https://github.com/mitmproxy/pdoc ) .
99
10- [ here ] : https://github.com/mitmproxy/pdoc
11-
12- Before reporting an issue, see if a similar issue is already open.
13- Also check if a similar issue was recently closed — your bug might
14- have been fixed already.
10+ Before reporting an issue, please see if a similar issue is already open.
11+ If applicable, also check if a similar issue has recently been closed
12+ — your bug might have been just fixed.
1513
1614To have your issue dealt with promptly, it's best to construct a
1715[ minimal working example] that exposes the issue in a clear and
@@ -27,7 +25,7 @@ first [fork the project]. Then:
2725
2826 git clone git@github.com:YOUR_USERNAME/pdoc
2927 cd pdoc
30- pip3 install -e . # Mind the dot
28+ pip install -e . # Mind the dot
3129
3230[ fork the project ] : https://help.github.com/articles/fork-a-repo/
3331
@@ -38,11 +36,11 @@ Please write reasonable unit tests for any new / changed functionality.
3836See _ pdoc/test_ directory for existing tests.
3937Before submitting a PR, ensure the tests pass:
4038
41- python setup.py test
39+ python -m unittest -v pdoc. test
4240
4341Also ensure that idiomatic code style is respected by running:
4442
45- flake8 --max-line-length 100
43+ flake8
4644
4745
4846Documentation
0 commit comments