mirror of
https://github.com/cisagov/manage.get.gov.git
synced 2025-07-26 04:28:39 +02:00
Merge pull request #628 from cisagov/mminaie-issue-template-v2
update suggestions from h-m-f-t
This commit is contained in:
commit
d3bc275c4e
2 changed files with 64 additions and 16 deletions
48
.github/ISSUE_TEMPLATE/bug.yml
vendored
Normal file
48
.github/ISSUE_TEMPLATE/bug.yml
vendored
Normal 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? feel free to include screenshots or other supporting artifacts"
|
||||||
|
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"
|
32
.github/ISSUE_TEMPLATE/issue-default.yml
vendored
32
.github/ISSUE_TEMPLATE/issue-default.yml
vendored
|
@ -1,32 +1,32 @@
|
||||||
name: Standard Issue Tempalte
|
name: Issue
|
||||||
description: Create an Issue
|
description: Provide a title for the issue you are describing
|
||||||
title: "[Issue]:"
|
title: "Please provide a clear title"
|
||||||
labels: ["research"]
|
labels: ["review"]
|
||||||
assignees:
|
# assignees:
|
||||||
- kitsushadow
|
# - kitsushadow
|
||||||
body:
|
body:
|
||||||
- type: markdown
|
- type: markdown
|
||||||
attributes:
|
attributes:
|
||||||
value: |
|
value: |
|
||||||
Please fill this out best you can
|
Describe the ticket your are capturing in further detail.
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: why
|
id: why
|
||||||
attributes:
|
attributes:
|
||||||
label: Why or Acceptance Criteria
|
label: Ticket Description
|
||||||
description: What is the reason we determined we need an issue.
|
description: Please provide details to accurately reflect why this ticket is being captured and also what is necessary to resolve.
|
||||||
placeholder: This issue is a product of...
|
placeholder: Provide details describing your lead up to needing this issue as well as any resolution or requirements for resolving or working on this more.
|
||||||
value: "While working on X or researching Y it was discovered that Z was an issue that need captured."
|
value: "While (working on or discussing) (issue #000 or domain request validation) I discovered there was (a missing workflow, an improvement, a missing feature). To resolve this (more research, a new feature, a new field, an interview) is required. Provide any links, screenshots, or mockups which would further detail the description."
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
- type: dropdown
|
- type: dropdown
|
||||||
id: type
|
id: type
|
||||||
attributes:
|
attributes:
|
||||||
label: Issue Type
|
label: Issue Type
|
||||||
description: What type of issue is this
|
description: Does this work require
|
||||||
options:
|
options:
|
||||||
- research (Default)
|
- discovery (Default)
|
||||||
- dev
|
- development
|
||||||
- product
|
- design review
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
- type: textarea
|
- type: textarea
|
||||||
|
@ -34,4 +34,4 @@ body:
|
||||||
attributes:
|
attributes:
|
||||||
label: Link dependent issues
|
label: Link dependent issues
|
||||||
description: If this ticket is dependent on another issue or blocks a current issue, please link.
|
description: If this ticket is dependent on another issue or blocks a current issue, please link.
|
||||||
render: shell
|
render: shell
|
Loading…
Add table
Add a link
Reference in a new issue