Documentation¶

Our documentation includes extensive information on features, installation, configurations, etc. If you have found an inconsistency or see room for improvement, please follow this guide to submit an issue on our issue tracker for the documentation repository.

Issue template¶

Title¶

A good title is short and descriptive. It should be a one-sentence executive summary of the idea, so the potential impact and benefit for our community can be inferred from the title.

App¶

Provide the application name for which you are filling the bug report.

Description¶

Next, provide a detailed and precise description of your idea. Adhere to the following principles:

• Explain the what, not the how – don't explain the benefits of your idea here, we're getting there. Focus on describing the proposed change request as precisely as possible.
• Keep it short and concise – be brief and to the point when describing your idea, there is no need to over-describe it. Maintainers and future users will be grateful for having to read less.
• One idea at a time – if you have multiple ideas that don't belong together, please open separate change requests for each of those ideas.

Why is this needed?¶

Describe the problem or need for this feature. Explain the benefits of your idea.

Proposed solution¶

Describe how this feature could be implemented.