Reporting Issues

Contributions in the form of issue reports are highly appreciated as they help to improve the quality of CHORAS and related projects.

Here are a couple of things to consider:

• We provide templates for issue reports on GitHub to help you provide all necessary information. When opening a new issue, please select the most appropriate template and make sure to fill out all required fields.

• Feel free to report issues on the CHORAS parent directory or on a specific subpackage if you think it more appropriate. In general, we recommend reporting issues on the parent directory; the maintainers will then move the issue to the appropriate location.

• When reporting bugs, please make sure to that others are able to reproduce the issue. Please provide an example as well as information about your environment (e.g., operating system, Python version, CHORAS version, and any other relevant packages) if applicable.

• If you are unsure about how to report an issue or which template to use, please feel free to reach out to us through Zulip.

• If you have access, you may also help categorizing issues by applying appropriate labels.

• If you want to work on the issue yourself, please feel free to indicate this in the issue description or open a pull request (see the Developer Guidelines for more information).

• If you are planning a larger feature or change, please consider discussing this first in a GitHub issue or on Zulip before opening a pull request.