Skip to content

Latest commit

 

History

History
19 lines (14 loc) · 811 Bytes

CONTRIBUTING.md

File metadata and controls

19 lines (14 loc) · 811 Bytes

Contributing

This project is pretty nascent right now, so if you really are interested in contributing, color me pleasantly suprised. That said, feel free to look at the open issues, leave a comment, open a PR, or shoot me an email.

Pull Requests

Personally, I'm a big fan of branch names that look like:

  • bug/broken-thing
  • feature/cool-idea
  • chore/boring-but-useful-thing

Open up a PR and fill out the pull request template. Your pull should include changes to the README if needs be.

Code Style

I'm an autopep8 enthusiast. I know Black is better. If you would like to contribute to this project, all I ask is that you install the pre-commit hook included in the repo. This will format your code every time you do a git commit and keep things homogeneous.