From 158a4caf9b2ecad093fb0bfdaa08869cd535086e Mon Sep 17 00:00:00 2001 From: Georgiana Dolocan Date: Wed, 14 Aug 2024 16:06:18 +0300 Subject: [PATCH 1/2] Update the new issue tempalte --- .../{01_new-issue.yml => 01_new-issue.yaml} | 12 ++++++++++++ 1 file changed, 12 insertions(+) rename .github/ISSUE_TEMPLATE/{01_new-issue.yml => 01_new-issue.yaml} (61%) diff --git a/.github/ISSUE_TEMPLATE/01_new-issue.yml b/.github/ISSUE_TEMPLATE/01_new-issue.yaml similarity index 61% rename from .github/ISSUE_TEMPLATE/01_new-issue.yml rename to .github/ISSUE_TEMPLATE/01_new-issue.yaml index 9d1bd819cc..6f937fc54b 100644 --- a/.github/ISSUE_TEMPLATE/01_new-issue.yml +++ b/.github/ISSUE_TEMPLATE/01_new-issue.yaml @@ -34,3 +34,15 @@ body: The Definition of Done. What must be true to consider this task complete? validations: required: true + + - type: checkboxes + attributes: + label: Pre-defined Definition of Done + description: A non-specific, pre-defined list of tasks that should be considered before marking the task complete. + options: + - label: All the tasks have been completed + required: false + - label: It has been tested to work and to not break any existing functionality + required: false + - label: Documentation was added so other engineers can implement this in the future if needed + required: false From c54771aca39b0529a1bf88ef7e4c5b61a51dd5a2 Mon Sep 17 00:00:00 2001 From: Georgiana Dolocan Date: Wed, 14 Aug 2024 16:53:21 +0300 Subject: [PATCH 2/2] Add dod for remaining issue tempaltes --- .github/ISSUE_TEMPLATE/05_decommission-hub.md | 9 ++++- .github/ISSUE_TEMPLATE/06_event-hub.yaml | 37 ++++++++++++------- 2 files changed, 30 insertions(+), 16 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/05_decommission-hub.md b/.github/ISSUE_TEMPLATE/05_decommission-hub.md index 1becb75da9..e06a9355e1 100644 --- a/.github/ISSUE_TEMPLATE/05_decommission-hub.md +++ b/.github/ISSUE_TEMPLATE/05_decommission-hub.md @@ -1,7 +1,7 @@ --- name: "\U0001F4E6 Decommission a Hub" about: Decommission a Hub that is no longer in active use -title: "[Decommission Hub] {{ HUB NAME }}" +title: "[Decommission Hub][{{ deadline }}] {{ HUB NAME }}" labels: '' assignees: '' @@ -38,9 +38,9 @@ Usually, it is because it was a hub that we created for a workshop/conference an - [ ] Remove the appropriate `config/clusters//.values.yaml` files. A complete list of relevant files can be found under the appropriate entry in the associated `cluster.yaml` file. - [ ] Remove the associated hub entry from the `config/clusters//cluster.yaml` file. - [ ] Remove the hub deployment + - TIP: Run `deployer use-cluster-credentials ` before running the commands below - `helm --namespace HUB_NAME delete HUB_NAME` - `kubectl delete namespace HUB_NAME` - - TIP: Run `deployer use-cluster-credentials ` before running the above commands #### Phase III - Cluster Removal @@ -56,3 +56,8 @@ _This phase is only necessary for single hub clusters._ - [ ] [`deploy-hubs.yaml`](https://github.com/2i2c-org/infrastructure/blob/HEAD/.github/workflows/deploy-hubs.yaml) - [ ] [`deploy-grafana-dashboards.yaml`](https://github.com/2i2c-org/infrastructure/blob/HEAD/.github/workflows/deploy-grafana-dashboards.yaml) - [ ] Remove A record from Namecheap account + +### Definition of Done +_A non-specific, pre-defined list of tasks that should be considered before marking the task complete._ +- [] All the tasks above have been completed +- [] Existing functionality was not broken diff --git a/.github/ISSUE_TEMPLATE/06_event-hub.yaml b/.github/ISSUE_TEMPLATE/06_event-hub.yaml index 547e34637c..0c883b8d17 100644 --- a/.github/ISSUE_TEMPLATE/06_event-hub.yaml +++ b/.github/ISSUE_TEMPLATE/06_event-hub.yaml @@ -1,6 +1,6 @@ name: 📅 Event for a community description: Coordination and planning around an event for a community -title: "[EVENT] {{ HUB NAME }}" +title: "[EVENT][{{ dates }}] {{ HUB NAME }}" labels: ["event"] body: - type: markdown @@ -27,7 +27,7 @@ body: description: | Type the GitHub handle of the community representative or their name if the handle is not known. validations: - required: true + required: false - type: textarea id: event_begin @@ -117,18 +117,27 @@ body: General checks to perform before the event. - - type: checkboxes - id: info_available + - type: textarea + id: tasks attributes: - label: Was all the info filled in above? - options: - - label: "Yes" - - label: "No" + label: Task list + description: | + (optional) A clear and concise list of steps to take to close this issue. + value: | + - [ ] Was all the info filled in above? + - [ ] Quotas from the cloud provider are high-enough to handle expected usage? + - [ ] + validations: + required: true - - type: checkboxes - id: quotas_ok + - type: textarea + id: dod attributes: - label: Quotas from the cloud provider are high-enough to handle expected usage? - options: - - label: "Yes" - - label: "No" + label: Definition of Done + description: | + The Definition of Done. What must be true to consider this task complete? + value: | + - [ ] All the tasks have been completed + - [ ] + validations: + required: true