feat: add acceptance criteria field to issue templates (#154)

# 📥 Pull Request ## ❓ What are you trying to address This pull request includes changes to add an "Acceptance Criteria" section to various issue templates in the repository. The most important changes include adding a new textarea field in three different issue templates to describe the functional criteria for feature acceptance. ## ✨ Description of new changes Enhancements to issue templates: * [`.github/ISSUE_TEMPLATE/feature_request.yml`](diffhunk://#diff-c6b098646bf32c644234bec14c2675ea2a3d9c2dc2df450a25aa0e7ff02323cdR60-R68): Added a new textarea field for "Acceptance Criteria" to describe the expected behavior of the feature. * [`.github/ISSUE_TEMPLATE/tfprovider_data_source_request.yml`](diffhunk://#diff-3363b4ebd01ea6ad113865c5b2d033b770df2b39203cc273faaa6e2d463afa16R71-R79): Added a new textarea field for "Acceptance Criteria" to describe the expected behavior of the feature. * [`.github/ISSUE_TEMPLATE/tfprovider_resource_request.yml`](diffhunk://#diff-c4eaf517a5af4e0890a9e5dc89340340a6d2f24988f55e068fdf8ae21b105e77R71-R79): Added a new textarea field for "Acceptance Criteria" to describe the expected behavior of the feature.
microsoft · Dec 18, 2024 · 6b2bffe · 6b2bffe
1 parent 163c711
commit 6b2bffe
Show file tree

Hide file tree

Showing 4 changed files with 58 additions and 13 deletions.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -17,7 +17,9 @@ body:
     id: description
     attributes:
       label: 🚀 Feature description
-      description: A clear and concise description of the feature or enhancement proposal.
+      description: |
+        A clear and concise description of the feature or enhancement proposal.
+        Try to follow the Job Story format: "When [situation] I want to [motivation] so I can [expected outcome]". Learn more about Job Stories: https://www.mountaingoatsoftware.com/blog/job-stories-offer-a-viable-alternative-to-user-stories
       placeholder: A clear and concise description of the feature or enhancement proposal.
     validations:
       required: true
@@ -45,6 +47,7 @@ body:
     attributes:
       label: 🚧 Potential Configuration / Desired Solution
       description: Sample config that describes how the new feature might look.
+      placeholder: Sample config that describes how the new feature might look.
     validations:
       required: false
 
@@ -57,6 +60,15 @@ body:
     validations:
       required: false
 
+  - type: textarea
+    id: acceptance-criteria
+    attributes:
+      label: ☑️ Acceptance Criteria
+      description: The functional criteria for the acceptance of this feature include a description of the expected behavior of the feature.
+      placeholder: The functional criteria for the acceptance of this feature include a description of the expected behavior of the feature.
+    validations:
+      required: false
+
   - type: checkboxes
     id: terms
     attributes:

diff --git a/.github/ISSUE_TEMPLATE/tfprovider_data_source_request.yml b/.github/ISSUE_TEMPLATE/tfprovider_data_source_request.yml
@@ -4,7 +4,7 @@
 name: 🔽 Provider Data Source Request
 description: Request a new data source to be added to the Terraform Provider 📢
 title: "[DS] "
-labels: [feature, data-source]
+labels: ["tf/data-source"]
 projects: ["microsoft/1018"]
 body:
   - type: textarea
@@ -14,6 +14,7 @@ body:
       description: |
         Short description here describing the new data source that you're requesting.
         Include a use case for why users need this data source.
+        Try to follow the Job Story format: "When [situation] I want to [motivation] so I can [expected outcome]". Learn more about Job Stories: https://www.mountaingoatsoftware.com/blog/job-stories-offer-a-viable-alternative-to-user-stories
     validations:
       required: true
 
@@ -25,13 +26,21 @@ body:
       placeholder: |
         - Data Source Name: `fabric_[your data source name]`
         - API documentation: <!-- links to API documentation (if public). What APIs are needed for read/list data? -->
+          - <!-- link 1 -->
+          - <!-- link 2 -->
         - Estimated complexity/effort: <!-- (e.g., easy, moderate, hard) -->
-        - Related resources/data sources: <!-- are there any existing or potential data sources that are related to this one -->
+        - Related resources/data-sources: <!-- are there any existing or potential data sources that are related to this one -->
+          - <!-- link 1 -->
+          - <!-- link 2 -->
       value: |
         - Data Source Name: `fabric_[your data source name]`
         - API documentation: <!-- links to API documentation (if public). What APIs are needed for read/list data? -->
+          - <!-- link 1 -->
+          - <!-- link 2 -->
         - Estimated complexity/effort: <!-- (e.g., easy, moderate, hard) -->
-        - Related resources/data sources: <!-- are there any existing or potential data sources that are related to this one -->
+        - Related resources/data-sources: <!-- are there any existing or potential data sources that are related to this one -->
+          - <!-- link 1 -->
+          - <!-- link 2 -->
     validations:
       required: false
 
@@ -68,6 +77,15 @@ body:
     validations:
       required: false
 
+  - type: textarea
+    id: acceptance-criteria
+    attributes:
+      label: ☑️ Acceptance Criteria
+      description: The functional criteria for the acceptance of this feature include a description of the expected behavior of the feature.
+      placeholder: The functional criteria for the acceptance of this feature include a description of the expected behavior of the feature.
+    validations:
+      required: false
+
   - type: checkboxes
     id: done-definition
     attributes:
@@ -76,11 +94,9 @@ body:
       options:
         - label: Data Transfer Objects (DTOs)
           required: false
-        - label: Data Client functions
-          required: false
-        - label: Data Source Implementation
+        - label: Data-Source Implementation
           required: false
-        - label: Data Source Added to Provider
+        - label: Data-Source Added to Provider
           required: false
         - label: Unit Tests for Happy path
           required: false

diff --git a/.github/ISSUE_TEMPLATE/tfprovider_docs_request.yml b/.github/ISSUE_TEMPLATE/tfprovider_docs_request.yml
@@ -14,6 +14,7 @@ body:
       description: |
         Short description describing the documentation that you're requesting.
         Include a use case for why users need this documentation.
+        Try to follow the Job Story format: "When [situation] I want to [motivation] so I can [expected outcome]". Learn more about Job Stories: https://www.mountaingoatsoftware.com/blog/job-stories-offer-a-viable-alternative-to-user-stories
     validations:
       required: true
 

diff --git a/.github/ISSUE_TEMPLATE/tfprovider_resource_request.yml b/.github/ISSUE_TEMPLATE/tfprovider_resource_request.yml
@@ -4,7 +4,7 @@
 name: 🔼 Provider Resource Request
 description: Request a new resource to be added to the Terraform Provider 📢
 title: "[RS] "
-labels: [feature, resource]
+labels: ["tf/resource"]
 projects: ["microsoft/1018"]
 body:
   - type: textarea
@@ -14,6 +14,7 @@ body:
       description: |
         Short description here describing the new resource that you're requesting.
         Include a use case for why users need this resource.
+        Try to follow the Job Story format: "When [situation] I want to [motivation] so I can [expected outcome]". Learn more about Job Stories: https://www.mountaingoatsoftware.com/blog/job-stories-offer-a-viable-alternative-to-user-stories
     validations:
       required: true
 
@@ -25,13 +26,21 @@ body:
       placeholder: |
         - Resource Name: `fabric_[your resource name]`
         - API documentation: <!-- links to API documentation (if public). What APIs are needed for read/list data? -->
+          - <!-- link 1 -->
+          - <!-- link 2 -->
         - Estimated complexity/effort: <!-- (e.g., easy, moderate, hard) -->
-        - Related resources/data sources: <!-- are there any existing or potential resources that are related to this one -->
+        - Related resources/data-sources: <!-- are there any existing or potential resources that are related to this one -->
+          - <!-- link 1 -->
+          - <!-- link 2 -->
       value: |
         - Resource Name: `fabric_[your resource name]`
         - API documentation: <!-- links to API documentation (if public). What APIs are needed for read/list data? -->
+          - <!-- link 1 -->
+          - <!-- link 2 -->
         - Estimated complexity/effort: <!-- (e.g., easy, moderate, hard) -->
-        - Related resources/data sources: <!-- are there any existing or potential resources that are related to this one -->
+        - Related resources/data-sources: <!-- are there any existing or potential resources that are related to this one -->
+          - <!-- link 1 -->
+          - <!-- link 2 -->
     validations:
       required: false
 
@@ -68,6 +77,15 @@ body:
     validations:
       required: false
 
+  - type: textarea
+    id: acceptance-criteria
+    attributes:
+      label: ☑️ Acceptance Criteria
+      description: The functional criteria for the acceptance of this feature include a description of the expected behavior of the feature.
+      placeholder: The functional criteria for the acceptance of this feature include a description of the expected behavior of the feature.
+    validations:
+      required: false
+
   - type: checkboxes
     id: done-definition
     attributes:
@@ -76,8 +94,6 @@ body:
       options:
         - label: Data Transfer Objects (DTOs)
           required: false
-        - label: Data Client functions
-          required: false
         - label: Resource Implementation
           required: false
         - label: Resource Added to Provider