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:
- 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.
- 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.
- For PRs, please have your feature branch set to merge into the
dev
branch. I'll later merge changes indev
into the mainline branch after enough significant changes. - Please be kind in your commit messages, PRs, and any opened issues.
- Any questions, feel free to open an issue or send me an email.