Skip to content

Commit

Permalink
docs: migrate rest
Browse files Browse the repository at this point in the history
  • Loading branch information
antazoey committed Sep 11, 2024
1 parent b397ab8 commit 494a64a
Show file tree
Hide file tree
Showing 5 changed files with 126 additions and 111 deletions.
85 changes: 43 additions & 42 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -1,46 +1,47 @@
name: Bug report
description: File a bug report
labels: 'category: bug'
body:
- type: markdown
attributes:
value: |
Please ensure that the bug has not already been filed in the issue tracker.
- type: markdown
attributes:
value: |
Please ensure that the bug has not already been filed in the issue tracker.
Thanks for taking the time to report this bug!
- type: checkboxes
attributes:
label: Have you ensured that all of these are up to date?
options:
- label: Ape
- label: Ape plugins
- type: input
attributes:
label: What version of Ape are you on?
placeholder: "Run `ape --version` and paste the output here"
- type: input
attributes:
label: What command(s) is the bug in?
description: Leave empty if not relevant
placeholder: "For example: ape test"
- type: dropdown
attributes:
label: Operating System
description: What operating system are you on?
options:
- Windows
- macOS (Intel)
- macOS (Apple Silicon)
- Linux
- type: textarea
attributes:
label: Ape config 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.
validations:
required: true
Thanks for taking the time to report this bug!
- type: checkboxes
attributes:
label: Have you ensured that all of these are up to date?
options:
- label: Ape
- label: Ape plugins
- type: input
attributes:
label: What version of Ape are you on?
placeholder: "Run `ape --version` and paste the output here"
- type: input
attributes:
label: What command(s) is the bug in?
description: Leave empty if not relevant
placeholder: "For example: ape test"
- type: dropdown
attributes:
label: Operating System
description: What operating system are you on?
options:
- Windows
- macOS (Intel)
- macOS (Apple Silicon)
- Linux
- type: textarea
attributes:
label: Ape config 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.
validations:
required: true
22 changes: 0 additions & 22 deletions .github/ISSUE_TEMPLATE/feature.md

This file was deleted.

32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: Feature Request
description: Request a new feature, or an improvement to existing functionality.
labels: 'category: feature'

body:
- type: input
id: describe
attributes:
label: Describe
description: "Provide a simple overview of what you wish to see added. Please include:"
placeholder: |
- What you are trying to do
- Why Ape's current functionality is inadequate to address your goal
validations:
required: false
- type: input
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!"
Remember, your feature is much more likely to be included if it does not involve any breaking changes.
validations:
required: false
- type: input
id: dependencies
attributes:
label: Dependencies
description: |
Include links to any open issues that must be resolved before this feature can be implemented.
validations:
required: false
47 changes: 0 additions & 47 deletions .github/ISSUE_TEMPLATE/work-item.md

This file was deleted.

51 changes: 51 additions & 0 deletions .github/ISSUE_TEMPLATE/work-item.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: Work Item
description: New work item for Ape team
body:
- type: input
id: pitch
attributes:
label: Evelator Pitch
placeholder: 1-2 line summary of the scope of this work item
- type: input
id: value
attributes:
label: Value
placeholder: |
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: input
id: dependencies
attributes:
label: Dependencies
placeholder: |
Call out key people, teams, tech dependencies, or assumptions.
- type: input
id: approach
attributes:
label: Design Approach
placeholder: |
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: input
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: input
id: date
attributes:
label: Estimated Completion Date
- type: input
id: review
attributes:
description: 1-2 people needed for signoff
label: |
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.
Design reviewers should consider simpler approaches to achieve goals.
(Please leave a comment to sign off)

0 comments on commit 494a64a

Please sign in to comment.