Skip to content

Latest commit

 

History

History
31 lines (21 loc) · 1.24 KB

CONTRIBUTING.md

File metadata and controls

31 lines (21 loc) · 1.24 KB

Contributing

Welcome! 🎉 Thanks you for taking the time to contribute.

Issues

These are where you report issues or bugs, request features, and stuff like that.

New to issues? Follow this link.

PRs

This is where you make changes to the project and submit them to review by the repo owner (me).

New to PRs? Follow this link.

Ideas

Some PRs I would love to see:

  • Fix python 3.5 support (as it hasn't quite reached EOL and I somehow broke support a few commits ago. See here for the broken build).

Suggestions

To increase the chances of your PR being accepted, follow these suggestions:

  • Lint with pylint, pycodestyle, and pydocstyle.
  • Use windows (CR LF) line endings.

Requirements

Your PR will not be accepted if it does not follow these requirements:

  • The Travis build passes.
  • Is both Windows, macOS and Linux compatible (will be tested by Travis.).
  • It's formatted with black.
  • It doesn't expand the scope of the project beyond what I am comfortable managing (I will be the judge of this, if you're unsure just go ahead and submit it anyway).