Skip to main content

Contributing

To efficiently address our users' needs, we carefully designed our contributing guidelines and optimized our issue templates to ensure a great overall experience with our project.

Our goal is to ensure that our documentation, as well as our issue tracker, are well-structured, easy to navigate, and searchable, so you can find what you need quickly and efficiently. Thus, when you follow our contribution guidelines, we can help you much faster.

In this section, we guide you through our processes.

Create an Issue​

  •   Something is not working?

    Report a bug in Zenzic by creating an issue containing a reproduction.

    Report a bug

  •   Missing information in our docs?

    Report missing information or potential inconsistencies in our documentation.

    Report a docs issue

  •   Want to submit an idea?

    Propose a change, feature request, or suggest an improvement.

    Request a change

Contribute​

  •   Want to contribute to the code?

    Contribute to the development of Zenzic by making a pull request.

    Make a pull request

Checklist​

Before interacting within the project, please take a moment to consider the following questions. By doing so, you ensure that you use the correct issue template and provide all necessary information when interacting with our community.

Issues and comments are forever

Please note that everything you write is permanent and will remain for everyone to read – forever. Therefore, we kindly ask you to always be nice and constructive, complying with our [Code of Conduct].

Before creating an issue​

  • Are you using the appropriate issue template, or is there another one that better fits the context of your request?

  • Have you checked if a similar bug report or change request has already been created, or have you stumbled upon something that might be related?

  • Did you fill out every field as requested, and did you provide all additional information we maintainers need to comprehend your request?

Before commenting​

  • Is your comment relevant to the topic of the current issue, or is it a better idea to create a new issue, as it's not or only loosely related?

  • Does your comment add value to the conversation? Is it constructive and respectful to our community and us maintainers? Could you just use a reaction instead?

Incomplete contributions​

We have carefully designed our contribution process to ensure that issues on our issue tracker can be reviewed and addressed efficiently. Each field in our issue templates is thoughtfully structured to capture the essential details needed to fully understand your concern.

Therefore, we require all requested information to be provided in full.

The checklist at the end of each template is a tool to help you verify that you've included everything necessary – it should not be marked off unless each point has been fully addressed.

We reserve the right to handle issues that do not adhere to our guidelines as follows:

Incomplete issues​

We reserve the right to close issues lacking essential information, such as missing reproductions or those not adhering to the quality standards and requirements specified in our issue templates. We'll reopen an issue once the missing information has been provided.

Questions as issues​

We reserve the right to close questions opened as any kind of issue. The issue tracker is not a place for questions, but rather for detailed bug reports, documentation issues, and change requests that adhere to the quality standards laid out in this guide.

Duplicated issues​

To maintain organized and efficient communication within our issue tracker, we reserve the right to close any duplicated issues.

Reopened issues​

We further reserve the right to immediately close issues that are reopened without providing new information.