Skip to content

Commit

Permalink
docs: fixes and review
Browse files Browse the repository at this point in the history
  • Loading branch information
antazoey committed Sep 11, 2024
1 parent 4be1ff6 commit cb891ed
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 25 deletions.
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
38 changes: 20 additions & 18 deletions .github/ISSUE_TEMPLATE/work-item.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,50 +2,52 @@ 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
description: 1-2 line summary of the scope of this work item
- type: textarea
attributes:
label: Value
placeholder: |
description: |
Who is this for?
Persona or group of people whom will derive value from the scenario.
What benefits will be achieved or business metrics improved?
- type: textarea
id: dependencies
attributes:
label: Dependencies
placeholder: |
description: |
Call out key people, teams, tech dependencies, or assumptions.
- type: textarea
id: approach
attributes:
label: Design Approach
placeholder: |
description: |
Free text / diagram / whiteboard picture / etc. that clearly shows your approach and considerations to build the task list.
Existing code patterns in production code base that you will base your work off of.
- type: markdown
id: tasks
attributes:
label: Task List
description: Bulleted list describing the exit criteria, desired end state and any documentation, monitors, work for DRI, etc. that will need to be added to make sure someone else can support once it's live.
placeholder: \[\] Tasks go here
- type: textarea
value: |
### Task List
Bulleted list describing the exit criteria, desired end state and any documentation, monitors, work for DRI, etc. that will need to be added to make sure someone else can support once it's live.
[ ] Tasks go here
- type: input
id: date
attributes:
label: Estimated Completion Date
- type: markdown
id: review
attributes:
description: 1-2 people needed for signoff
label: |
value: |
### Sign-off
1-2 people needed for signoff
Do not signoff unless:
- 1. agreed the tasks and design approach will achieve acceptance, and
- 2. the work can be completed by one person within the SLA.
1. agreed the tasks and design approach will achieve acceptance, and
2. the work can be completed by one person within the SLA.
Design reviewers should consider simpler approaches to achieve goals.
(Please leave a comment to sign off)

0 comments on commit cb891ed

Please sign in to comment.