Welcome to Inkycal! We are excited that you are considering contributing to our project. Before you get started, please take a moment to read through our contribution guidelines.
This project and everyone participating in it are governed by our Code of Conduct. By participating, you are expected to uphold this code. Please report any unacceptable behavior.
Before submitting a bug report, check if the issue is already reported in the Issues section. If not, please open a new issue with a detailed description of the problem, including steps to reproduce it.
We welcome suggestions for new features or enhancements. Use the Issues section to submit your ideas, and provide as much detail as possible.
So you had a great idea for an inkycal-module? Awesome! In fact, there is already a repo sepcfifically created for that purpose: inkycal-modules-template. Just fork that repo, add your module and give me a shout via Discord, Github or Email.
- Fork the repository and create a new branch for your feature or bug fix.
- Make your changes and test thoroughly.
- Ensure your code follows our coding standards.
- Update the documentation if necessary.
- Add your name in the file
CONTRIBUTORS.md. - Open a pull request, referencing any related issues.
Follow our coding standards to maintain consistency across the project. Check the existing codebase to understand the style and conventions.
Ensure that your changes are thoroughly tested. If applicable, provide test cases to cover your code.
By contributing, you agree that your contributions will be licensed under the LICENSE file of this project.
Thank you for considering contributing to Inkycal! Your help is invaluable, and we appreciate your time and effort.
Happy coding!