Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: internal issue tempalte for tests #399

Merged
merged 6 commits into from
Feb 9, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_internal.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/test_internal.md
Original file line number Diff line number Diff line change
@@ -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.

<!-- Base checklist. Don’t hesitate to adapt it to your use-case. -->

### Links / references / screenshots