pyo3/.github/pull_request_template.md

13 lines
765 B
Markdown
Raw Normal View History

2019-03-10 21:16:49 +00:00
Thank you for contributing to pyo3!
Here are some things you should check for submitting your pull request:
- Run `cargo fmt` (This is checked by travis ci)
- Run `cargo clippy` and check there are no hard errors (There are a bunch of existing warnings; This is also checked by travis)
- If applicable, add an entry in the changelog.
- If applicable, add documentation to all new items and extend the guide.
- If applicable, add tests for all new or fixed functions
2019-09-05 23:16:09 +00:00
- If you changed any python code, run `black .`. You can install black with `pip install black`)
2019-03-10 21:16:49 +00:00
You might want to run `tox` (`pip install tox`) locally to check compatibility with all supported python versions. If you're using linux or mac you might find the Makefile helpful for testing.