Merge pull request #641 from cisagov/bl-bug-issue-template

Add bug issue template example
This commit is contained in:
Mohammad Minaie 2023-05-24 09:38:05 -04:00 committed by GitHub
commit f4ef042314
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

48
.github/ISSUE_TEMPLATE/bug.yml vendored Normal file
View file

@ -0,0 +1,48 @@
name: Bug
description: Report a bug
title: "[Bug]: "
labels: ["bug"]
body:
- type: textarea
id: current-behavior
attributes:
label: Current Behavior
description: "Please add a concise description of the issue"
placeholder: "Example: The application shows an internal server error when attempting to apply for a new domain"
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Expected Behavior
description: "Please add a concise description of the behavior you would expect if this issue were not occurring"
placeholder: "Example: When submitting a new domain application, the request should be successful, OR if there is a problem with the user's application preventing submission, errors should be enumerated to the user"
validations:
required: true
- type: textarea
id: steps-to-reproduce
attributes:
label: Steps to Reproduce
description: "How can the issue be reliably reproduced?"
placeholder: |
Example:
1. In the test environment, fill out the application for a new domain
2. Click the button to trigger a save/submit on the final page and complete the application
3. See the error
validations:
required: true
- type: textarea
id: environment
attributes:
label: Environment
description: "Where is this issue occurring? If related to development environment, list the specific relevant tool versions"
placeholder: |
Example:
- Browser: Chrome x.y.z
- Python: x.y.z
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: "Please include additional references, screenshots, documentation, etc. that are relevant"