CONTRIBUTING.md

Contributing

Hello. 👋 First off, thanks for taking the time to consider contributing. 💙 Keyszer is a volunteer effort. We'd love if you decided to pitch in and join our team! 🎉

Did you find a bug or unexpected behavior? 🐞

• Do not open a GitHub issue if the bug is a serious security vulnerability, instead refer to our security policy.
• Please ensure the bug was not already reported by searching on GitHub Issues.
• If you're unable to find an existing issue, open a new one. Be sure to include a title and clear description, as much relevant information as possible, along with verbose log output and clear steps to reproduce the problem.

Did you write a patch that fixes a bug? 🔧

• Open a new GitHub pull request with the patch.
• Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

Do you want to contribute but have no idea where or how to start? 🤔

• You may want to checkout any issues tagged good first issue and help welcome.

Do you have a great idea for a change or entirely new feature? 💡

• Suggest your proposed feature or change and it's benefits by opening a new issue.
• Participate in the discussion and listen to feedback to learn if your change is in-scope and would be accepted before putting lots of time and effort into writing the code.

Did you fix whitespace, format code, or make a purely cosmetic patch? 🦋

• Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability of the project will generally not be accepted.

Do you have questions about the code? 💻

• Feel free to open an issue with your question, or better yet, join us on Discord.

Thanks so very much! ❤️ 💙 ❤️

Josh Goebel