Before checking the support guideline, please read through our Code of Conduct.
Refer to the Table of Contents to explore the various types of support available and learn about their respective procedures. Prior to creating your GitHub Q&A Discussion or Issue, kindly review the appropriate section to facilitate the process for both maintainers and the community, ensuring a smoother experience for everyone involved.
Before you ask a question yourself, it is best to search for existing Q&A discussions that might help you, you can always continue an already existing discussion. It is also advisable to search the internet for answers. In case you didn't find a suitable answer, you can create a Q&A discussion yourself:
- Open a Q&A Discussion.
- Give it a clear title and make sure to provide all relevant information.
We will then take care of the Q&A discussion as soon as possible.
You may always ask us questions through our Discord server as well.
This section guides you through submitting a bug report for the Discord bot. Following these guidelines will help maintainers and the community to understand your report and find related ones.
A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
- Determine if your bug is really a bug and not an error on your side (e.g. a misconfigured YAML file).
- Make sure to search the internet to see if users outside of the GitHub Community have discussed the issue.
- To see if other users have experienced (and potentially already solved) the same bug you are having, check if there is not already a bug report existing for your bug in the issue tracker. If there is, add a comment to the existing one instead of opening a new one.
- Collect the following information about the bug:
- Device OS
- Device chipset
- Bug description
- Bug replication steps
You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead use the GitHub Security Advisory section for sensitive bugs.
Bug reports are tracked as GitHub Issues. To submit a new bug report:
- Open a Bug Report issue.
- Fill in the template and provide the information you collected in the previous section.
Once it is filed:
- A team member will try to reproduce the bug with your provided steps. Bug reports without (clear) reproduction steps will not be addressed until they can be reproduced.
- If the team is able to reproduce the bug a fix will be left to be implemented by someone.
You may always make bug reports through our Discord server as well (using the #support channel).
This section guides you through submitting an enhancement suggestion for the Discord bot, including completely new features and minor improvements to existing functionality. Following these guidelines will help maintainers and the community to understand your suggestion and find related ones.
A good enhancement suggestion shouldn't leave others needing to chase you up for more information. Please complete the following steps in advance to help us consider any enhancement suggestion as fast as possible.
- Find out if the functionality is already covered, maybe by an individual configuration.
- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this enhancement. Keep in mind that we want enhancements that will be useful to the majority of our users and not just a small subset.
- To see if other users have suggested the same enhancement, check if there is not already a feature enhancement related to yours existing in the issue tracker. If there is, add a comment to the existing one instead of opening a new one.
Enhancement suggestions are tracked as GitHub Issues. To submit a new enhancement suggestion:
- Open an Enhancement Suggestion issue.
- Fill in the template and make sure to provide all relevant information.
Once it is filed:
- A team member will review your enhancement suggestion and discuss its feasibility and impact on the project.
- If the enhancement is deemed appropriate and aligns with the project's goals, it will be labeled accordingly and left to be implemented by someone.
You may always make enhancement suggestions through our Discord server as well (using the #support channel).