Bug reports
Zenzic is an actively maintained project that we constantly strive to improve. With a project of this size and complexity, bugs may occur. If you think you have discovered a bug, you can help us by submitting an issue in our public issue tracker, following this guide.
Before creating an issue
We aim to keep the number of open issues low by addressing bugs promptly. Before submitting a new issue, please complete the following steps.
Upgrade to the latest version
Chances are that the bug you discovered was already fixed in a subsequent version. Before reporting an issue, ensure that you're running the [latest version] of Zenzic.
Only bugs that occur in the latest version of Zenzic will be addressed.
Search for solutions
Before creating a bug report, do some research:
-
Search our documentation and look for sections related to your problem.
-
Search our issue tracker, as another user might already have reported the same problem.
Keep track of all search terms and relevant links; you'll need them in the bug report.
Issue template
Our issue template consists of the following parts:
Title
A good title is short and descriptive — a one-sentence executive summary of the issue.
| Example | |
|---|---|
| Clear | validate_same_page_anchors raises false positive on auto-generated headings |
| Unclear | Anchor validation doesn't work |
| Useless | Help |
Context optional
Provide additional context to help us understand what you were trying to achieve. Don't write about the bug here.
Bug description
Provide a clear, focused, and concise summary of the bug. Adhere to the following principles:
-
Explain the what, not the how – focus on the problem and its impact, not how to reproduce it.
-
Keep it short and concise – one or two sentences is ideal.
-
One bug at a time – create separate issues for unrelated bugs.
Related links
Share links to all documentation sections relevant to the bug, as well as any related issues you found while searching.
Reproduction
A minimal reproduction is at the heart of every well-written bug report. It allows us to instantly recreate the conditions needed to find the root cause.
After creating the reproduction, attach the .zip file directly to the issue.
Please attach a .zip reproduction rather than linking to a repository.
Steps to reproduce
List the specific steps we should follow when running your reproduction to observe the bug. Keep the steps concise and complete.
Checklist
Thanks for following the guide and creating a high-quality bug report. The checklist ensures that you have read this guide and provided us with everything we need to help you.
We'll take it from here.