- The change should happen
- The bug is a bug
- The feature is an improvement
- The code belongs in QTrio, not another package
- Unless it is a workaround in QTrio temporarily or because the proper library has declined to resolve the issue.
- Relevant bugs or features are being tested
- The line coverage provided by automatic coverage checks are valuable but you are the only one that can decide if the proper functionality is being tested
- Documentation updates
- Docstrings are present and accurate for all modules, classes, methods, and functions including private ones and tests.
- For bug fixes consider if the docs should be updated to clarify proper behavior
- For feature additions consider if prose in the docs should be updated in addition to the docstrings.
- The change is described for the user
- If this is a change relevant to users, there should be a newsfragment file as follows
- Newsfragment file name has the proper issue or PR number and change type
- The contents describe the change well for users
- Proper Sphinx references are used where appropriate