Skip to content

Latest commit

 

History

History
61 lines (42 loc) · 1.73 KB

CONTRIBUTING.md

File metadata and controls

61 lines (42 loc) · 1.73 KB

Contributing guidelines

Issues

Only report issues for PyPI package pdoc3. If your issue pertains to the other PyPI package pdoc, report its issue here.

Before reporting an issue, please see if a similar issue is already open. If applicable, also check if a similar issue has recently been closed — your bug might have been just fixed.

To have your issue dealt with promptly, it's best to construct a minimal working example that exposes the issue in a clear and reproducible manner.

Installation

To install a developmental version of the project, first fork the project. Then:

git clone [email protected]:YOUR_USERNAME/pdoc
cd pdoc
pip install -e .   # Mind the dot

Testing

Please write reasonable unit tests for any new / changed functionality. See pdoc/test directory for existing tests. Before submitting a PR, ensure the tests pass:

python -m unittest -v pdoc.test

Also ensure that idiomatic code style is respected by running:

flake8

Documentation

See doc/README.md. All documentation is generated from pdoc-compatible docstrings in code.

Pull requests

If you're new to proposing changes on GitHub, help yourself to an appropriate guide. Additionally, please use explicit commit messages. See NumPy's development workflow for inspiration.