From 494a64a3d27136299d4ca377f9e529eb1e65a1d0 Mon Sep 17 00:00:00 2001 From: Juliya Smith Date: Wed, 11 Sep 2024 13:06:28 -0500 Subject: [PATCH] docs: migrate rest --- .github/ISSUE_TEMPLATE/bug.yml | 85 ++++++++++++++-------------- .github/ISSUE_TEMPLATE/feature.md | 22 ------- .github/ISSUE_TEMPLATE/feature.yml | 32 +++++++++++ .github/ISSUE_TEMPLATE/work-item.md | 47 --------------- .github/ISSUE_TEMPLATE/work-item.yml | 51 +++++++++++++++++ 5 files changed, 126 insertions(+), 111 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/feature.md create mode 100644 .github/ISSUE_TEMPLATE/feature.yml delete mode 100644 .github/ISSUE_TEMPLATE/work-item.md create mode 100644 .github/ISSUE_TEMPLATE/work-item.yml diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index 89c74acf63..9260483fd0 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/feature.md b/.github/ISSUE_TEMPLATE/feature.md deleted file mode 100644 index 374749692d..0000000000 --- a/.github/ISSUE_TEMPLATE/feature.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -name: Feature request -about: Request a new feature, or an improvement to existing functionality. -labels: 'category: feature' ---- - -### Overview - -Provide a simple overview of what you wish to see added. Please include: - -- What you are trying to do -- Why Ape's current functionality is inadequate to address your goal - -### Specification - -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. - -### Dependencies - -Include links to any open issues that must be resolved before this feature can be implemented. diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml new file mode 100644 index 0000000000..d046702186 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/work-item.md b/.github/ISSUE_TEMPLATE/work-item.md deleted file mode 100644 index 6587ddff06..0000000000 --- a/.github/ISSUE_TEMPLATE/work-item.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -name: Work item -about: New work item for Ape team ---- - -### Elevator pitch: - - - -### Value: - - - -### Dependencies: - - - -### Design approach: - - - -### Task list: - - - -- \[ \] Tasks go here - -### Estimated completion date: - -### Design review: - - - -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) diff --git a/.github/ISSUE_TEMPLATE/work-item.yml b/.github/ISSUE_TEMPLATE/work-item.yml new file mode 100644 index 0000000000..0cc4694d5b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/work-item.yml @@ -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)