Raising an Issue

1. Check the issues page for related issues

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

2. Create a new issue (if necessary)

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.