50 lines
2.2 KiB
Markdown
50 lines
2.2 KiB
Markdown
# Contributing to Inkycal
|
|
|
|
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.
|
|
|
|
## Code of Conduct
|
|
|
|
This project and everyone participating in it are governed by our [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report any unacceptable behavior.
|
|
|
|
## How Can I Contribute?
|
|
|
|
### Reporting Bugs
|
|
|
|
Before submitting a bug report, check if the issue is already reported in the [Issues](https://github.com/aceinnolab/Inkycal/issues) section. If not, please open a new issue with a detailed description of the problem, including steps to reproduce it.
|
|
|
|
### Suggesting Enhancements
|
|
|
|
We welcome suggestions for new features or enhancements. Use the [Issues](https://github.com/aceinnolab/Inkycal/issues) section to submit your ideas, and provide as much detail as possible.
|
|
|
|
### Third party modules
|
|
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](https://github.com/aceisace/inkycal-modules-template). Just fork that repo, add your module and give me a shout via Discord, Github or Email.
|
|
|
|
|
|
### Pull Requests
|
|
|
|
1. Fork the repository and create a new branch for your feature or bug fix.
|
|
2. Make your changes and test thoroughly.
|
|
3. Ensure your code follows our coding standards.
|
|
4. Update the documentation if necessary.
|
|
5. Add your name in the file `CONTRIBUTORS.md`.
|
|
6. Open a pull request, referencing any related issues.
|
|
|
|
## Code Standards
|
|
|
|
Follow our coding standards to maintain consistency across the project. Check the existing codebase to understand the style and conventions.
|
|
|
|
## Testing
|
|
|
|
Ensure that your changes are thoroughly tested. If applicable, provide test cases to cover your code.
|
|
|
|
## License
|
|
|
|
By contributing, you agree that your contributions will be licensed under the [LICENSE](https://github.com/aceinnolab/Inkycal/blob/main/LICENSE) file of this project.
|
|
|
|
## Thank You
|
|
|
|
Thank you for considering contributing to Inkycal! Your help is invaluable, and we appreciate your time and effort.
|
|
|
|
Happy coding!
|
|
|