From 566a0ae1dbc0a24d7f7f60654cc32c026deeb555 Mon Sep 17 00:00:00 2001 From: Mohammad Minaie Date: Thu, 18 May 2023 11:47:04 -0400 Subject: [PATCH 1/7] update suggestions from h-m-f-t --- .github/ISSUE_TEMPLATE/issue-default.yml | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/issue-default.yml b/.github/ISSUE_TEMPLATE/issue-default.yml index ecfa56140..0ab2335bb 100644 --- a/.github/ISSUE_TEMPLATE/issue-default.yml +++ b/.github/ISSUE_TEMPLATE/issue-default.yml @@ -1,32 +1,32 @@ -name: Standard Issue Tempalte +name: Standard Issue Template description: Create an Issue -title: "[Issue]:" +title: "[Issue]: " labels: ["research"] -assignees: - - kitsushadow +# assignees: +# - kitsushadow body: - type: markdown attributes: value: | - Please fill this out best you can + Describe an issue, idea, task, bug, or story. - type: textarea id: why attributes: label: Why or Acceptance Criteria - description: What is the reason we determined we need an issue. + description: What is the reason it was determined this is an issue. placeholder: This issue is a product of... - value: "While working on X or researching Y it was discovered that Z was an issue that need captured." + value: "While working on X or researching Y it was discovered that Z was an issue that needed captured." validations: required: true - type: dropdown id: type attributes: label: Issue Type - description: What type of issue is this + description: What kind of role would take action on your issue? options: - research (Default) - - dev - - product + - development + - product team validations: required: true - type: textarea From d75c3e0ea61aee121a716b312eaae4ffee35b9b4 Mon Sep 17 00:00:00 2001 From: Mohammad Minaie Date: Fri, 19 May 2023 11:42:02 -0400 Subject: [PATCH 2/7] update suggestions from h-m-f-t --- .github/ISSUE_TEMPLATE/issue-default.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/issue-default.yml b/.github/ISSUE_TEMPLATE/issue-default.yml index 0ab2335bb..6cd021a2e 100644 --- a/.github/ISSUE_TEMPLATE/issue-default.yml +++ b/.github/ISSUE_TEMPLATE/issue-default.yml @@ -1,7 +1,7 @@ -name: Standard Issue Template -description: Create an Issue -title: "[Issue]: " -labels: ["research"] +name: Issue +description: Provide a title for the issue you are describing +title: "" +labels: ["review"] # assignees: # - kitsushadow body: From 785da453d588b81158a15d29610ccac0cfdd0d4e Mon Sep 17 00:00:00 2001 From: Mohammad Minaie Date: Fri, 19 May 2023 14:18:33 -0400 Subject: [PATCH 3/7] title must be a non-empty string --- .github/ISSUE_TEMPLATE/issue-default.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/issue-default.yml b/.github/ISSUE_TEMPLATE/issue-default.yml index 6cd021a2e..eeaa4fed2 100644 --- a/.github/ISSUE_TEMPLATE/issue-default.yml +++ b/.github/ISSUE_TEMPLATE/issue-default.yml @@ -1,6 +1,6 @@ name: Issue description: Provide a title for the issue you are describing -title: "" +title: "Please provide a clear title" labels: ["review"] # assignees: # - kitsushadow From 2816acb924a7a76f159cf6c26e2f527253fd36af Mon Sep 17 00:00:00 2001 From: brandonlenz Date: Mon, 22 May 2023 16:50:58 -0400 Subject: [PATCH 4/7] Add base for bug template --- .github/ISSUE_TEMPLATE/bug.yml | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug.yml diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 000000000..de76ed3fd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,5 @@ +name: Bug +description: Report a bug +title: "[Bug]: " +labels: ["bug"] + From c6b18361d164ae6494faecd92fa3985cee516544 Mon Sep 17 00:00:00 2001 From: brandonlenz Date: Mon, 22 May 2023 17:14:00 -0400 Subject: [PATCH 5/7] Add body --- .github/ISSUE_TEMPLATE/bug.yml | 43 ++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index de76ed3fd..34b0362d4 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -3,3 +3,46 @@ 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 that are relevant" From c488a33c67093c712f70aa0c78b413ced4e2f022 Mon Sep 17 00:00:00 2001 From: brandonlenz Date: Mon, 22 May 2023 17:40:38 -0400 Subject: [PATCH 6/7] update context description --- .github/ISSUE_TEMPLATE/bug.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index 34b0362d4..8ef05c048 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -45,4 +45,4 @@ body: id: additional-context attributes: label: Additional Context - description: "Please include additional references, screenshots, documentation that are relevant" + description: "Please include additional references, screenshots, documentation, etc. that are relevant" From a4dae87c43d81719897aae6c5886a2136e825fe0 Mon Sep 17 00:00:00 2001 From: Mohammad Minaie Date: Wed, 24 May 2023 10:08:21 -0400 Subject: [PATCH 7/7] updates to language in the default issue, merger of the bug PR, and updates to some of the bug language --- .github/ISSUE_TEMPLATE/bug.yml | 2 +- .github/ISSUE_TEMPLATE/issue-default.yml | 18 +++++++++--------- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index 8ef05c048..c01761f1c 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -24,7 +24,7 @@ body: id: steps-to-reproduce attributes: label: Steps to Reproduce - description: "How can the issue be reliably reproduced?" + 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 diff --git a/.github/ISSUE_TEMPLATE/issue-default.yml b/.github/ISSUE_TEMPLATE/issue-default.yml index eeaa4fed2..665ba530d 100644 --- a/.github/ISSUE_TEMPLATE/issue-default.yml +++ b/.github/ISSUE_TEMPLATE/issue-default.yml @@ -8,25 +8,25 @@ body: - type: markdown attributes: value: | - Describe an issue, idea, task, bug, or story. + Describe the ticket your are capturing in further detail. - type: textarea id: why attributes: - label: Why or Acceptance Criteria - description: What is the reason it was determined this is an issue. - placeholder: This issue is a product of... - value: "While working on X or researching Y it was discovered that Z was an issue that needed captured." + label: Ticket Description + description: Please provide details to accurately reflect why this ticket is being captured and also what is necessary to resolve. + 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 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: required: true - type: dropdown id: type attributes: label: Issue Type - description: What kind of role would take action on your issue? + description: Does this work require options: - - research (Default) + - discovery (Default) - development - - product team + - design review validations: required: true - type: textarea @@ -34,4 +34,4 @@ body: attributes: label: Link dependent issues description: If this ticket is dependent on another issue or blocks a current issue, please link. - render: shell + render: shell \ No newline at end of file