Skip to content

Commit 4d67976

Browse files
committed
DOC: Minor revise CONTRIBUTING.md
1 parent aef1917 commit 4d67976

File tree

1 file changed

+9
-11
lines changed

1 file changed

+9
-11
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,13 @@ Contributing guidelines
33

44
Issues
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

1614
To 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.
3836
See _pdoc/test_ directory for existing tests.
3937
Before submitting a PR, ensure the tests pass:
4038

41-
python setup.py test
39+
python -m unittest -v pdoc.test
4240

4341
Also ensure that idiomatic code style is respected by running:
4442

45-
flake8 --max-line-length 100
43+
flake8
4644

4745

4846
Documentation

0 commit comments

Comments
 (0)