docs: fixes and review

ApeWorX · Sep 11, 2024 · 6e5ce7e · 6e5ce7e
1 parent 4be1ff6
commit 6e5ce7e
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 13 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml
@@ -34,14 +34,14 @@ body:
         - Linux
   - type: textarea
     attributes:
-      label: Ape config file
+      label: ape-config.yaml file
       description: "Please paste your `ape-config.yaml` contents here (NOTE: do not post anything private like RPC urls or secrets!)"
       placeholder: "Run `cat ape-config.yaml` and copy and paste the result here"
     validations:
       required: true
   - type: textarea
     attributes:
-      label: Reproduce the bug
-      description: Please include a simple reproduction snippet.
+      label: Reproduction code
+      description: Please include a simple reproduction code-snippet.
     validations:
       required: true
diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml
@@ -7,18 +7,18 @@ body:
     id: describe
     attributes:
       label: Describe
-      description: "Provide a simple overview of what you wish to see added. Please include:"
+      description: "Provide a simple overview of what you wish to see added."
       placeholder: |
-        - What you are trying to do
-        - Why Ape's current functionality is inadequate to address your goal
+        I am trying to ...
+        Ape's current functionality is inadequate because ...
     validations:
       required: false
   - type: textarea
     id: specification
     attributes:
       label: Specification
       description: |
-        Describe the syntax and semantics of how you would like to see this feature implemented. The more detailed the better!"
+        Describe the syntax and semantics of how you would like to see this feature implemented. The more detailed the better!
         Remember, your feature is much more likely to be included if it does not involve any breaking changes.
     validations:
       required: false

diff --git a/.github/ISSUE_TEMPLATE/work-item.yml b/.github/ISSUE_TEMPLATE/work-item.yml
@@ -2,12 +2,10 @@ name: Work Item
 description: New work item for Ape team
 body:
   - type: textarea
-    id: pitch
     attributes:
       label: Evelator Pitch
       placeholder: 1-2 line summary of the scope of this work item
-  - type: input
-    id: value
+  - type: textarea
     attributes:
       label: Value
       placeholder: |
@@ -21,7 +19,6 @@ body:
       placeholder: |
          Call out key people, teams, tech dependencies, or assumptions.
   - type: textarea
-    id: approach
     attributes:
       label: Design Approach
       placeholder: |
@@ -38,10 +35,10 @@ body:
     attributes:
       label: Estimated Completion Date
   - type: markdown
-    id: review
     attributes:
-      description: 1-2 people needed for signoff
+      value:
       label: |
+        1-2 people needed for signoff
         Do not signoff unless:
 
         - 1. agreed the tasks and design approach will achieve acceptance, and