mirror of
https://github.com/zensical/zensical.git
synced 2026-08-24 08:06:50 +00:00
33 lines
2.3 KiB
Markdown
33 lines
2.3 KiB
Markdown
# Contributing
|
||
|
||
Zensical is an actively maintained and constantly improved project that serves a diverse user base with varying backgrounds and needs. We genuinely appreciate every contribution, whether it's reporting a bug, suggesting an improvement, or helping others in the community.
|
||
|
||
To make it as easy as possible to contribute, we have put significant effort into creating clear templates for [our issue tracker]. We want to make sure all the information we need is there from the start, so we can focus on what matters: building the best possible product together.
|
||
|
||
[our issue tracker]: https://github.com/zensical/zensical/issues
|
||
|
||
## How to contribute
|
||
|
||
Whether you want to report a bug, suggest an improvement, or help others in the community, each of these processes is covered in detail in [our documentation]. Find whatever fits your situation in the list below:
|
||
|
||
[our documentation]: https://zensical.org/docs/
|
||
|
||
- [Ask a question](https://zensical.org/docs/community/get-involved/#discord)
|
||
- [Report a bug](https://zensical.org/docs/community/contribute/report-a-bug/)
|
||
- [Report a docs issue](https://zensical.org/docs/community/contribute/report-a-docs-issue/)
|
||
- [Request a change](https://zensical.org/docs/community/contribute/request-a-change/)
|
||
- [Create a pull request](https://zensical.org/docs/community/contribute/pull-requests/)
|
||
|
||
## Before creating an issue
|
||
|
||
Before opening an issue, please take a moment to check whether a similar report or request already exists – a quick search can save everyone time. When you do open one, please fill out all fields in the issue template completely. Every field is there for a reason, and a thorough issue helps us understand and address your concern much faster.
|
||
|
||
A few things to keep in mind:
|
||
|
||
- **Issues are permanent.** Everything written on our issue tracker is public and stays there, so please be constructive and respectful at all times, in line with our [Code of Conduct].
|
||
- **Use the right template.** Each template is designed for a specific purpose – pick the one that best fits your situation.
|
||
- **Keep it focused.** If your comment doesn't add to the current discussion, consider opening a new issue or using a reaction instead.
|
||
- **Questions belong in Discord.** The issue tracker is for bug reports, documentation issues, and change requests – not general questions.
|
||
|
||
[Code of Conduct]: CODE_OF_CONDUCT.md
|