Thank you for considering contributing to the package!
Please don't use the issue tracker for this. The issue tracker is a tool to address bugs and feature requests in the code source itself.
Support is not provided for this package.
When reporting an issue, please include the following information:
- Describe what you expected to happen;
- If possible, include a minimal reproducible example to help identify the issue. This also helps check that the issue is not with your own code;
- Describe what actually happened. Include the full trace-back if there was an exception;
- List your Python and package versions. If possible, check if this issue is already fixed in the latest releases or the latest code in the repository.
The best way to send feedback is to file an issue.
If you are proposing a feature:
- Explain in detail how it would work;
- Keep the scope as narrow as possible, to make it easier to implement;
- Remember that this is a volunteer-driven project, and that code contributions are welcome.
Documentation can always be improved, whether as part of the official docs or in doc-strings. Please first discuss any deviations from the current documentation formats already in use in the package.
If there is not an open issue for what you want to submit, the preference is for you to open one for discussion before working on a pull request. You can work on any issue that doesn't have an open PR linked to it or a maintainer assigned to it. These show up in the sidebar. There is no need to ask if you can work on an issue that interests you.
It is suggested that you fork to a branch named after the issue (ie not main) to simplify merge/rebase.
When submitting your patch, please ensure that you:
- Test your code;
- Include type annotations;
- Update any relevant docs pages and doc-strings;
- Add an entry in
CHANGES.md; - Ideally run pre-commit, and correct any issues.