Thank you for taking the time to help us improve our open-source projects maintained by the CDR Data Standards Body. To ensure that your issues are addressed efficiently, please follow these guidelines when submitting a report.

Before You Report

1. Check the Documentation: Sometimes the issue is already covered in our documentation. Please review it to see if your question or problem has already been addressed.
2. Search Existing Issues: Take a moment to search through the existing issues on our GitHub repository or support forum to avoid duplicating reports. If you find your issue already reported, feel free to add additional information or express your interest in resolving it by commenting.

How to Report an Issue

To make the issue reporting process as effective as possible, please include the following information in your report:

1. Title: Provide a clear and concise title that summarises the issue.
2. Issue Type: Specify the type of issue you are reporting:

• Bug: Problems that cause incorrect functionality.
• Enhancement: Suggestions for new features or improvements to existing features.
• Documentation: Inaccuracies, enhancements, or suggestions for the documentation.

1. Description:
   • What you were doing: Describe the actions you took leading up to the issue.
   • What you expected to happen: Clearly describe what you expected to happen.
   • What actually happened: Explain what actually occurred, including how it differed from your expectations.
2. Reproduction Steps:
   • List the steps needed to reproduce the issue.
   • If applicable, include code samples or screenshots demonstrating the problem.
3. Environment:
   • Operating System: Specify your operating system and version.
   • Software Version: Include the version of our product you are using.
   • Dependencies: List any relevant dependencies or third-party tools.
4. Severity and Impact:
   • Describe the severity and potential impact of the issue. For example, is it a minor visual bug, or does it cause a major functionality breakdown?
5. Additional Information:
   • Include any other information that might be relevant, such as workaround solutions you have tried or links to related issues.

Issue Follow-Up

Once you've submitted your issue, our team will review it and respond as soon as possible. You can track the progress of your issue through our tracking system, and we may contact you for further information if necessary.

Contact

If you have questions about the issue reporting process or require immediate assistance, please contact our team at [email protected].