diff --git a/.github/ISSUE_TEMPLATE/feature_internal.md b/.github/ISSUE_TEMPLATE/feature_internal.md index d291b5900..415483cab 100644 --- a/.github/ISSUE_TEMPLATE/feature_internal.md +++ b/.github/ISSUE_TEMPLATE/feature_internal.md @@ -13,6 +13,15 @@ A clear and concise description of the feature to be implemented and why. ### Proposal A plan or brief overview of how the feature will be implemented. +### Testing +A detailed description of how this feature will be tested. + +* What are the core aspects of the feature that need testing? +* Outline the test cases and for each specify: + * The purpose of the test. + * The inputs. + * The expected output. + ### Definition of done A precise outline for the feature to be considered fully implemented, i.e. done/complete. diff --git a/.github/ISSUE_TEMPLATE/test_internal.md b/.github/ISSUE_TEMPLATE/test_internal.md new file mode 100644 index 000000000..e287def1d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/test_internal.md @@ -0,0 +1,29 @@ +--- +name: Planned test +about: Outline the structure for a planned test, this could be broader system/integration tests or for tests for existing code. +title: '[TEST]' +labels: test +assignees: '' + +--- + +### What do you want to test? +A brief description of the feature to be tested (with a link to the feature issue, if applicable). + +### Outline of test structure +* What type of test(s)? i.e. unit, integration, functional. +* Describe the test cases and for each: + * What will be the inputs? + * What is the expected output? + +### Definition of done +A precise description for the test(s) to be considered fully implemented, i.e. done/complete. + +### Mandatory checklist before making a PR +* [ ] The success criteria laid down in “Definition of done” are met. +* [ ] Test code is documented - docstrings for methods and classes, static types for arguments. +* [ ] Documentation is updated - README, CONTRIBUTING, or other documentation. + + + +### Links / references / screenshots