Contributing to kaydet

First off, thank you for considering contributing to kaydet. It's people like you that make kaydet such a great tool.

Our Philosophy

Before you start, please take a moment to read our guiding principles outlined in The Zen of kaydet. All contributions should align with this philosophy to ensure the project remains consistent and true to its core values.

How to Contribute

There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into kaydet itself.

Reporting Bugs

• Ensure the bug was not already reported by searching on GitHub under Issues.
• If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Suggesting Enhancements

• Read the philosophy to see if your suggestion aligns with the project's goals.
• Open a new issue on GitHub. Please provide a clear description of the enhancement and its potential benefits.

Pull Requests

• Fork the repo and create your branch from master.
• If you've added code that should be tested, add tests.
• Ensure the test suite passes.
• Make sure your code lints.
• Issue that pull request!

Code of Conduct

Please be respectful and constructive in all interactions.