Skip to content

Latest commit

 

History

History
7 lines (6 loc) · 951 Bytes

CONTRIBUTING.md

File metadata and controls

7 lines (6 loc) · 951 Bytes

Howdy! Thanks for wanting to contribute! I don't really have a whole lot of requirements for contributing to this project as it's so small, but just a couple guidelines:

  1. Before contributing code for a new feature, please open an issue to create some discussion on the feature. The last thing I'd want is code written for a feature that doesn't end up getting merged in.
  2. Please make sure to test your code before opening a PR! This project doesn't (yet) have any automated tests (unless you'd like to write some?) so testing PRs is a must. I'll test PRs as well before merging them in, but I'm only one person and may miss some stuff.
  3. For PRs, please have your feature branch set to merge into the dev branch. I'll later merge changes in dev into the mainline branch after enough significant changes.
  4. Please be kind in your commit messages, PRs, and any opened issues.
  5. Any questions, feel free to open an issue or send me an email.