Raising an Issue

Please follow these steps:

This avoids duplication, and groups similar tasks and issues together, simplifying development.

If the same issue has been raised before, continue discussion and development under that issue
If there are no related issues, create a new issue
If there are other related issues, but it seems like a new issue would be useful because the problem is self-contained, or it is otherwise different enough from the existing issues, create a new issue.
- In this case, make a note of the related issue numbers

This is necessary to hold a record of the issue, and its progress to completion.

On the issues page click the New Issue button
Complete the issue template (Summary, Description, etc.) as completely as possible
- If there is an error traceback, include it
- If a command line reproducibly gives the error, include it
- When appropriate - if possible - include a minimal input dataset for reproducibility
If there are related issue numbers, please include them with the hash syntax (e.g. #123 to mention issue number 123). This links the issues together so that we can track related problems and requests.

NB. The following instructions require access to features unavailable to users; only maintainers are expected to follow these.

This helps us triage and prioritise issues.

Please select all relevant labels; these can be modified later if not appropriate

This helps manage overall progress of the project.

pyani Project
pyani Milestones
All issues should be added to the project pyani
If the issue is a bug in existing function, add it to the earliest future milestone
Feature requests should be added to an appropriate milestone.
- If unsure which milestone to choose, please contact @widdowquinn or @baileythegreen