Skip to main content

Reporting Issues

When reporting issues, clear communication is essential for effective resolution. A well-documented report helps the team understand the problem quickly and accurately, leading to faster solutions.

Pre-flight Checklist​

We value your time as much as ours. To ensure your request receives the attention it deserves, we kindly ask you to:

  • Clearly describe the problem in detail, rather than just saying "it doesn't work."
  • Provide a minimal reproduction that we can easily run.
  • Include a live deployment URL that demonstrates the issue (if applicable).
  • Share as much relevant information as possible: code snippets, repository URLs, git branch links, full stack traces, screenshots, and videos.
  • Present your request clearly and concisely, demonstrating that you've put in effort to assist us in helping you.

Bugs🐛​

Submit a bug report if you notice something works incorrectly or behaves unexpectedly, and make sure that:

Docs📒​

Documentation-related issues focus on improving the clarity, accuracy, or completeness of project documentation.

Common types of documentation issues include:

  • Inaccuracies: Incorrect information that needs to be updated.
  • Clarity: Sections that are confusing or difficult to understand.
  • Missing Information: Important details that are not covered in the documentation.
  • Outdated Content: Information that is no longer relevant due to updates in the software.

When creating a documentation issue, be sure to include specific examples of the problem and suggest possible improvements. This proactive approach can lead to more effective documentation and a better user experience.

Feature Requests❓​

You can use the feedback board to submit casual feature requests if you're not ready to open a pull request. It’s a simple way to share your ideas and get community feedback.

  • Title: A clear and descriptive title for the request.
  • Description: A detailed explanation of the proposed feature and its benefits.

We prioritize developing features based on votes and trending suggestions, so your input matters!

Proposals💡​

If you intend to make any non-trivial changes to existing implementations, we kindly ask you to start by discussing the change you wish to make. This allows us to have an open dialogue about your proposed changes, ensuring that everyone is on the same page and understands the context and goals behind the modification. Get started.