Update CONTRIBUTING.md
This commit is contained in:
parent
084a44a5e5
commit
41ea263257
60
.github/CONTRIBUTING.md
vendored
60
.github/CONTRIBUTING.md
vendored
@ -1,31 +1,49 @@
|
||||
# Inkycal Contribution Policy
|
||||
# Contributing to Inkycal
|
||||
|
||||
Thanks for willing to contribute to Inkycal
|
||||
We welcome all sort of contributions, for example:
|
||||
* giving support via the Discord server
|
||||
* submitting hotfixes for existing bugs
|
||||
* giving ideas for new features
|
||||
* financial contributions (while Inkycal is still dependent on them. These go towards new hardware, displays and a bit of coffee)
|
||||
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.
|
||||
|
||||
# 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. If it is really unique and convincing, chances are, if you agree, that it will be available as default module in a future release. Please do not attempt to have it merged straight into main. We try not to touch main except for new releases to keep things consistent, stable and easy-to-maintain.
|
||||
## Code of Conduct
|
||||
|
||||
# Code contributions (PRs, hotfixes, Critical improvements)
|
||||
So you found a bug in Inkycal and tested out a bugfix? Kudos! Please fork the Inkycal repo, add your changes in there and create a PR targeting main. For all other PRs, please target a different branch.
|
||||
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.
|
||||
|
||||
Don't forget to add your name in the file `CONTRIBUTORS.md` of the corresponding branch. Thank You!
|
||||
## How Can I Contribute?
|
||||
|
||||
# Submitting Issues
|
||||
### Reporting Bugs
|
||||
|
||||
Please only submit reproducible issues with clear instructions on how to reproduce them.
|
||||
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.
|
||||
|
||||
When you are submitting a new issue, please supply the following information:
|
||||
### Suggesting Enhancements
|
||||
|
||||
### Release version
|
||||
* are you using main or a different branch. In most cases, this is main
|
||||
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.
|
||||
|
||||
### Expected behavior and actual behavior
|
||||
* what were you expecting to happen and what did really happen?
|
||||
### 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!
|
||||
|
||||
### Steps to reproduce the behavior
|
||||
* How can the devs re-create the same problem you were having?
|
||||
|
Loading…
Reference in New Issue
Block a user