Merge pull request #458 from Alexander-N/doctest

Fixup for Contributing.md
This commit is contained in:
konstin 2019-04-23 22:20:54 +02:00 committed by GitHub
commit 661f472660
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -6,9 +6,9 @@ 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 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
- Run `cargo test` or if you changed examples in README or the guide
- Run `cargo test`
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.