🚧Fix issue with pr description during initial sync (#229)

* Start work for issue #226 * fix: fix admonition for pr descriptions * docs: improve issue templates
KinsonDigital · Aug 28, 2024 · 6a090e8 · 6a090e8
1 parent 6fa7332
commit 6a090e8
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 14 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug-issue-template.yml b/.github/ISSUE_TEMPLATE/bug-issue-template.yml
@@ -1,7 +1,7 @@
 name: 🐛 Bug
 description: File a bug
 title: "🐛"
-labels: [bug, ⚕️NEEDS TRIAGE]
+labels: [🐛bug, ⚕️NEEDS-TRIAGE]
 projects: ["KinsonDigital/11"]
 body:
 - type: checkboxes

diff --git a/.github/ISSUE_TEMPLATE/project-item-issue-template.yml b/.github/ISSUE_TEMPLATE/project-item-issue-template.yml
@@ -20,23 +20,27 @@ body:
 - type: textarea
   attributes:
     label: Acceptance Criteria
-    description: The items to complete in order to satisfy the Definition of Done.
+    description: The items to complete to satisfy the Definition of Done.
     value: |
       ```[tasklist]
-      ### The items to complete in order to satisfy the Definition of Done.
+      ### The items to complete to satisfy the Definition of Done.
+      - [ ] All the unit tests have been executed and passed locally after PR work is complete. _(Why? Refer to 'Additional Information' below.)_
       ```
   validations:
     required: true
     render: markdown
 
-- type: checkboxes
+- type: textarea
   attributes:
     label: ToDo Items
     description: Complete the following items before requesting a PR review.
-    options:
-    - label: Change type labels added to this issue.  Refer to the _**Change Type Labels**_ section below.
-    - label: Priority label added to this issue.  Refer to the _**Priority Type Labels**_ section below.
-    - label: Issue linked to the correct milestone _(if applicable)_.
+    value: |
+      ```[tasklist]
+      ### The items to complete to satisfy the Definition of Done.
+      - [ ] Add a change type label to the issue. Refer to the _**Change Type Labels**_ section below.
+      - [ ] Add a priority label to the issue. Refer to the _**Priority Type Labels**_ section below.
+      - [ ] Link the issue to the correct milestone _(if applicable)_.
+      ```
 
 - type: textarea
   attributes:
@@ -72,8 +76,8 @@ body:
       | Change Type         | Label                |
       |---------------------|----------------------|
       | Bug Fixes           | `🐛bug` |
-      | Breaking Changes    | `🧨breaking changes` |
-      | New Feature         | `✨new feature` |
+      | Breaking Changes    | `🧨breaking-changes` |
+      | New Feature         | `✨new-feature` |
       | CICD Changes        | `♻️cicd` |
       | Config Changes      | `⚙️config` |
       | Code Doc Changes    | `🗒️documentation/code` |
@@ -84,9 +88,9 @@ body:
       
       | Priority Type       | Label             |
       |---------------------|-------------------|
-      | Low Priority        | `low priority`    |
-      | Medium Priority     | `medium priority` |
-      | High Priority       | `high priority`   |
+      | Low Priority        | `low-priority`    |
+      | Medium Priority     | `medium-priority` |
+      | High Priority       | `high-priority`   |
       </details>
 
 - type: checkboxes

diff --git a/cicd/core/PRTemplateManager.ts b/cicd/core/PRTemplateManager.ts
@@ -157,7 +157,7 @@ export class PRTemplateManager {
 		result += "or do not match the associated issue.";
 
 		result += "\n4. To manually sync the pull request to the issue, create a comment with the `[run-sync]` command.";
-		result += "\n\t> **Note** You must be an admin member of the organization to use this command.";
+		result += "\n> [!Note] You must be an admin member of the organization to use this command.";
 
 		return result;
 	}