We welcome all contributions, bug reports, bug fixes, documentation improvements, enhancements, and ideas. We are working on our contribution guidelines, but in the meantime we can help you get started if you contact us directly on Gitter. If you would rather wait for our guidelines, click to watch the Cauldron repository. You’ll stay up-to-date on our progress and may join us at any time.
The goal of the bug report is to explain to us how to reproduce the bug on our computers. Only submit a report for a bug you can reproduce. Limit your report to one bug (no bug is too small to report). Include as much detail as possible in clear, precise English. Please include in your report:
- A title that explains the bug in a few words
- The steps to reproduce the bug
- Expected results
- Actual results
- What you have tried to fix the bug
- The version of Cauldron
- Versions of all relevant software, e.g., python, operating systems, etc.
Before creating enhancement suggestions, please check if that enhancement already exists. To submit your suggestion create an issue in the Cauldron repository and provide the following information:
- Use a clear and descriptive title for the issue to identify the suggestion.
- Explain why this enhancement would be useful.
- Provide a step-by-step description of the suggested enhancement in as many details as possible.
- Provide specific examples to demonstrate the steps. Include copy/pasteable snippets which you use in those examples.
- Describe the current behavior and explain what behavior you expected to see instead and why.
- Specify which version of Cauldron you're using.
- Specify the name and version of the OS you're using and all relevant software.