diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000..fd4a5fb82 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,33 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: bug +assignees: en-milie + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behaviour: +1. Run `cats --contract ...` or `cats run --contract ...` or `cats fuzz ...` +2. Using which OpenAPI file (or redacted version/section of it) +3. And any additional headers provided using `-H` or `--headers` +4. And any relevant other arguments +5. See error + +**Expected behaviour** +A clear and concise description of what you expected to happen. + +**Environment:** +* Provide the output of: `cats info` or `java -jar cats.jar` +* OpenAPI file: it would be great if you can provide the OpenAPI file used, a redacted version of it or just the section related to the bug +* FunctionalFuzzer file: if the issue is related to running `cats run ...` using the [FunctionalFuzzer](https://endava.github.io/cats/docs/fuzzers/special-fuzzers/functional-fuzzer/) +* SecurityFuzzer file: if the issue is related to running `cars run ...` using the [SecurityFuzzer](https://endava.github.io/cats/docs/fuzzers/special-fuzzers/security-fuzzer/) +* Request template: if the issue is related to running `cats fuzz ...` using the [TemplateFuzzer](https://endava.github.io/cats/docs/fuzzers/special-fuzzers/template-fuzzer/) +* User dictionary: if the issue is related to running CATS with a [custom dictionary](https://endava.github.io/cats/docs/getting-started/custom-dictionary) + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 000000000..bbcbbe7d6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here.