From 01f3ee9b4aa36bd53c016c6ef0dcac062686a880 Mon Sep 17 00:00:00 2001 From: Irena Jurica Date: Sat, 9 Nov 2024 22:17:14 +0100 Subject: [PATCH] FOCUS #604: Issue templates review (#612) Upon reviewing the existing five issue templates, I propose keeping the following three: - **Work Item template:** - Primarily for FOCUS Project members. - If we reach consensus on removing the Discussion template, any necessary changes to this template can be addressed in this PR. - **Feedback template:** - Primarily for FOCUS User Group members. - To be used for providing feedback for the following areas: - Unsupported/missing FinOps features, use cases, or scenarios - Existing FOCUS specification content - Other - See the changed files for specific updates suggested in this PR. - **Maintenance template:** - Out of scope for this PR. - Primarily deals with GitHub-related tasks, the mechanics of generating the spec (PDF and HTML), etc. As for the **Spec Change** and **Discussion** templates, I propose we discard both: - **Spec Change template:** - The group has already discussed this and largely agreed to remove it. Once formal consensus is reached, this PR can include its removal. - **Discussion template:** - I recommend we discard this template as well. - FOCUS Project members can use the **Work Item** template to introduce discussion topics as potential Work Item candidates or placeholders. These placeholders can be labeled appropriately until fully completed and ready for review and triage by the group. - When and if consensus is reached on this approach, this PR can handle the removal. --------- Co-authored-by: Joaquin --- .github/ISSUE_TEMPLATE/discussion-topic.md | 20 --- .github/ISSUE_TEMPLATE/discussion-topic.yml | 45 ------ .github/ISSUE_TEMPLATE/feedback.md | 78 +++++++++++ .github/ISSUE_TEMPLATE/feedback.yml | 147 +++++++++++++++----- .github/ISSUE_TEMPLATE/spec-change.md | 25 ---- .github/ISSUE_TEMPLATE/spec-change.yml | 51 ------- .github/ISSUE_TEMPLATE/work-item.yml | 18 +-- 7 files changed, 198 insertions(+), 186 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/discussion-topic.md delete mode 100644 .github/ISSUE_TEMPLATE/discussion-topic.yml create mode 100644 .github/ISSUE_TEMPLATE/feedback.md delete mode 100644 .github/ISSUE_TEMPLATE/spec-change.md delete mode 100644 .github/ISSUE_TEMPLATE/spec-change.yml diff --git a/.github/ISSUE_TEMPLATE/discussion-topic.md b/.github/ISSUE_TEMPLATE/discussion-topic.md deleted file mode 100644 index e5443e87e..000000000 --- a/.github/ISSUE_TEMPLATE/discussion-topic.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Discussion Topic -about: Discussion topics that require broader input from FOCUS members -title: Title of the discussion topic OR open question needing member feedback -labels: discussion topic -assignees: '' - ---- - -### Description -> Describe the discussion topic and/or open topic is. Describe discussion that has taken place and where community feedback is needed. Provide specifics (specially if there are multiple possible options). - -### Proposed approach -> Describe the approach that your group is proposing - -### Github issue or Reference -> If the topic is related to a particular work item, reference the Github issue. If its a specification-wide topic, indicate that. - -### Context -> Add any context that may help the community think through this and provide useful feedback diff --git a/.github/ISSUE_TEMPLATE/discussion-topic.yml b/.github/ISSUE_TEMPLATE/discussion-topic.yml deleted file mode 100644 index 08d54d674..000000000 --- a/.github/ISSUE_TEMPLATE/discussion-topic.yml +++ /dev/null @@ -1,45 +0,0 @@ -name: Discussion Topic -description: Initiate discussion on broad topics within the FOCUS community. -title: "[DISCUSSION]: " -labels: ["discussion topic"] -assignees: ["shawnalpay"] -body: - - type: textarea - attributes: - label: Description - description: Describe the discussion topic, the discussions that have already taken place, and where community feedback is needed. Provide specifics, especially if there are multiple possible options. - placeholder: Describe the topic and any prior discussions here. - validations: - required: true - - - type: textarea - attributes: - label: Proposed Approach - description: Describe the approach that your group is proposing for the discussion topic. - placeholder: Outline your proposed approach here. - validations: - required: true - - - type: input - attributes: - label: GitHub Issue or Reference - description: If the topic is related to a particular work item, reference the GitHub issue here. If it's a specification-wide topic, indicate that. - placeholder: e.g., Issue #123 or Specification-wide - validations: - required: false - - - type: textarea - attributes: - label: Context - description: Add any context that may help the community think through this and provide useful feedback. - placeholder: Provide additional context here. - validations: - required: false - - - type: textarea - attributes: - label: Data Submission for Discussion - description: Provide relevant sample data or data extracts that support your discussion. Ensure data is anonymized and does not include sensitive or proprietary information. - placeholder: Attach sample data or data extracts here. Ensure compliance with data privacy guidelines. - validations: - required: false diff --git a/.github/ISSUE_TEMPLATE/feedback.md b/.github/ISSUE_TEMPLATE/feedback.md new file mode 100644 index 000000000..a5cb2d3ed --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feedback.md @@ -0,0 +1,78 @@ +# Feedback on Unsupported Features, Use Cases, and Existing FOCUS Spec. +description: Provide feedback on unsupported FinOps features, use cases, or scenarios, as well as on the existing FOCUS specification content. Avoid sharing proprietary information. +title: "[FEEDBACK]" +labels: ["feedback"] +assignees: [shawnalpay, jpradocueva] + +--- + +### **Template Usage Notes**: +1. All fields marked as **mandatory** [*] must be filled before submission. +2. For **Supporting Data/Documentation**, ensure that linked files are accessible to relevant stakeholders. + +## 1. **Problem statement** +Describe the problem or opportunity that this issue addresses. Explain the context and why it needs resolution. + +**Summary: [*]** +_Briefly describe the problem or opportunity that this issue addresses and why it needs resolution._ +> **Placeholder:** Briefly describe the problem or opportunity that needs resolution. + +**Which area does this issue relate to? [*]** +_Select one of the provided options:_ +- A: Missing FinOps feature, use case, or scenario +- B: Existing FOCUS specification content +- C: Other + +**Detailed Description [*]:** +_Provide a detailed description of the problem or opportunity. Add context or any other relevant information that may help in addressing this issue._ +> **Placeholder:** Provide a comprehensive description of the problem or opportunity, including context and any relevant details. + +## 2. **Use Cases** +Please describe the use cases, whether FinOps-related or otherwise, that cannot be performed with the existing specification unless this issue is addressed. + +**What use cases, FinOps or others, can't be performed with the existing specification unless this issue is addressed? [*]** +_Provide detailed descriptions of the use cases that can't be performed unless this issue is addressed._ +> **Placeholder:** List the specific use cases that can't be performed due to the existing limitations. + +## 3. **FinOps Personas** +List the FinOps personas this issue relates to. + +**Which FinOps personas does this issue relate to? [*]** +_Indicate which FinOps personas this issue relates to._ +> **Placeholder:** e.g., Practitioner, Executive, Finance, Engineering, Procurement, Operations, etc. + +## 4. **Providers** +List provider groups or specific providers this issue relates to. + +**Which provider groups or specific providers does this issue relate to? [*]** +_List provider groups (e.g., CSPs, SaaS) separated by semicolons (`;`), and specific providers within those groups separated by commas (`,`). If the issue applies to all providers within a group, you can simply specify the group name (e.g., 'All CSPs')._ +> **Placeholder:** e.g., All CSPs; SaaS: Snowflake, Salesforce + +## 5. **Criticality Scale** +Indicate how critical this issue or feature request is for your organization using the scale provided below. + +**On a scale of 1 - 4, how critical is this for your organization? [*]** +_Select one of the provided options:_ +- 1: Critical - Blocks my organization from adopting FOCUS +- 2: Important - Ideally resolved within the next 3-6 months +- 3: Important - Ideally resolved within the next 6-12 months +- 4: Suggestion - Resolution not urgent + +## 6. **Objective** +State the objective of this feedback. +- What outcome is expected? +- Define how success will be measured (e.g., metrics and KPIs). + +**Objective:** +_Outline the expected outcome and success criteria._ +> **Placeholder:** Outline the desired outcome and any metrics or KPIs to measure success. + +## 7. **Supporting Data/Documentation** + +**Data Examples:** +_Provide links to relevant sample data or attach data extracts that support your feedback. Ensure data is anonymized and does not include sensitive or proprietary information._ +> **Placeholder:** Add link(s) to sample data or attach extracts that support your feedback. + +**Issues, PRs, or Other References:** +_Provide links to any relevant GitHub issues, pull requests, or other applicable references._ +> **Placeholder:** Add links to any relevant GitHub issues, pull requests, or other applicable references. diff --git a/.github/ISSUE_TEMPLATE/feedback.yml b/.github/ISSUE_TEMPLATE/feedback.yml index 656903ca8..db90a1289 100644 --- a/.github/ISSUE_TEMPLATE/feedback.yml +++ b/.github/ISSUE_TEMPLATE/feedback.yml @@ -1,48 +1,113 @@ -name: Feature Request and Use Case Feedback -description: Provide feedback on unsupported use cases or features in the FOCUS specification, including FinOps scenarios, to help prioritize updates. Avoid sharing proprietary information. +name: "Feature Request and Use Case Feedback" +description: "Provide feedback on unsupported FinOps features, use cases, or scenarios, as well as on the existing FOCUS specification content. Avoid sharing proprietary information." title: "[FEEDBACK]: " -labels: ["use case"] -assignees: ["shawnalpay, jpradocueva,"] +labels: + - "feedback" +assignees: + - "shawnalpay" + - "jpradocueva" body: - type: markdown attributes: - value: "FOCUS working group seeks gaps in the current specification for FinOps and beyond. Share unsupported use cases or features to prioritize updates. Avoid sharing proprietary information." - + value: | + --- + ### **Template Usage Notes**: + 1. All fields marked as **mandatory** [*] must be filled before submission. + 2. For **Supporting Data/Documentation**, ensure that linked files are accessible to relevant stakeholders. + + + - type: markdown + attributes: + value: | + ## 1. **Problem statement** + Describe the problem or opportunity that this issue addresses. Explain the context and why it needs resolution. + + - type: textarea + id: issue-summary + attributes: + label: Summary + description: "Briefly describe the problem or opportunity that this issue addresses and why it needs resolution." + placeholder: "Briefly describe the problem or opportunity that needs resolution." + validations: + required: true + + - type: dropdown + id: issue-area + attributes: + label: Which area does this issue relate to? + description: "Select one of the provided options:" + options: + - 'A: Missing FinOps feature, use case, or scenario' + - 'B: Existing FOCUS specification content' + - 'C: Other' + validations: + required: true + - type: textarea + id: issue-description attributes: - label: Proposed Change - description: Short description of the change and why it is necessary. - placeholder: Describe the proposed change briefly and why it is necessary + label: Detailed Description + description: "Provide a detailed description of the problem or opportunity. Add context or any other relevant information that may help in addressing this issue." + placeholder: "Provide a comprehensive description of the the problem or opportunity, including context and any relevant details" validations: required: true - + + - type: markdown + attributes: + value: | + ## 2. **Use Cases** + Please describe the use cases, whether FinOps-related or otherwise, that cannot be performed with the existing specification unless this issue is addressed. + - type: textarea + id: use_cases attributes: - label: What use cases, FinOps or others, can't be performed with the current specification without this change? - description: Describe in detail the use cases, whether FinOps-related or otherwise, that your organization cannot perform with the current specification without the proposed change. + label: What use cases, FinOps or others, can't be performed with the existing specification unless this issue is addressed? + description: "Provide detailed descriptions of the use cases that can't be performed unless this issue is addressed." + placeholder: "List the specific use cases that can't be performed due to the existing limitations." validations: required: true - - type: input + - type: markdown attributes: - label: Which FinOps personas perform this use case? - description: List one or more FinOps personas that perform this use case - placeholder: e.g., Cost Analyst, Cloud Architect, etc + value: | + ## 3. **FinOps Personas** + List the FinOps personas this issue relates to. + + - type: textarea + id: finops-personas + attributes: + label: Which FinOps personas does this issue relate to? + description: "Indicate which FinOps personas this issue relates to." + placeholder: "e.g., Practitioner, Executive, Finance, Engineering, Procurement, Operations, etc." validations: required: true - - type: input + - type: markdown + attributes: + value: | + ## 4. **Providers** + List provider groups or specific providers this issue relates to. + + - type: textarea + id: providers attributes: - label: For which providers do you perform this use case for? - description: List each provider separated by commas - placeholder: e.g., AWS, Azure, GCP, Snowflake, etc + label: Which provider groups or specific providers does this issue relate to? + description: "List provider groups (e.g., CSPs, SaaS) separated by semicolons (`;`), and specific providers within those groups separated by commas (`,`). If the issue applies to all providers within a group, you can simply specify the group name (e.g., 'All CSPs')." + placeholder: "e.g., All CSPs; SaaS: Snowflake, Salesforce" validations: required: true + - type: markdown + attributes: + value: | + ## 5. **Criticality Scale** + Indicate how critical this issue or feature request is for your organization using the scale provided below. + - type: dropdown + id: criticality-scale attributes: - label: Criticality Scale - description: On a scale of 1 - 4, how critical is this for your organization? + label: On a scale of 1 - 4, how critical is this for your organization? + description: "Select one of the provided options." options: - '1: Blocks my organization from adopting FOCUS' - '2: Important for adoption in the next 3-6 months' @@ -51,26 +116,42 @@ body: validations: required: true + - type: markdown + attributes: + value: | + ## 6. **Objective** + State the objective of this feedback. + - What outcome is expected? + - Define how success will be measured (e.g., metrics and KPIs). + - type: textarea + id: objective attributes: - label: Key Metrics and KPIs - description: List the metrics and KPIs that will measure the success of this use case (e.g., cost per service, spend reduction percentage). - placeholder: e.g., cost per service, spend reduction percentage, etc. + label: "Objective" + description: "Outline the expected outcome and success criteria." + placeholder: "Outline the desired outcome and any metrics or KPIs to measure success." validations: required: false + - type: markdown + attributes: + value: | + ## 7. **Supporting Data/Documentation** + - type: textarea + id: data_examples attributes: - label: Context / Supporting information - description: Provide any other relevant information here - placeholder: Additional details... + label: "Data Examples" + description: "Provide links to relevant sample data or attach data extracts that support your feedback. Ensure data is anonymized and does not include sensitive or proprietary information." + placeholder: "Add link(s) to sample data or attach extracts that support your feedback." validations: - required: true + required: false - type: textarea + id: issue_pr_references attributes: - label: Data Submission for Discussion - description: Provide relevant sample data or data extracts that support your feedback. Ensure data is anonymized and does not include sensitive or proprietary information. - placeholder: Attach sample data or data extracts here. Ensure compliance with data privacy guidelines. + label: "Issues, PRs, or Other References" + description: "Provide links to any relevant GitHub issues, pull requests, or other applicable references." + placeholder: "Add links to any relevant GitHub issues, pull requests, or other applicable references." validations: - required: false + required: false diff --git a/.github/ISSUE_TEMPLATE/spec-change.md b/.github/ISSUE_TEMPLATE/spec-change.md deleted file mode 100644 index 0e8003855..000000000 --- a/.github/ISSUE_TEMPLATE/spec-change.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -name: Spec Change -about: Spec change issue -title: Spec Change title -labels: spec change -assignees: '' ---- - -### Type -> Type of issue (e.g. Dimension, Metric, Attribute, Documentation etc.) -Normalized? Yes | No - - -### Description -> Description of the issue - -### Definition of done - -- [ ] Rationalize vendor-neutral, cross-cloud naming -- [ ] Complete spec template and include naming (code name, display name), constraints, guidelines, compatibility with major providers etc. -** If Normalized Dimension ** -- [ ] Include principles and governance criteria for maintaining this dimension - -** If Normalized Dimension ** -Work for generating the normalized list of supported values is tracked in a separate issue. Mappings between normalized values and vendor specified values need to be explored as a part of this work. However, these mappings are not included in the spec documentation. Separate tasks will be created for making these mappings available to practitioners outside of the FOCUS repository. diff --git a/.github/ISSUE_TEMPLATE/spec-change.yml b/.github/ISSUE_TEMPLATE/spec-change.yml deleted file mode 100644 index aa4104c63..000000000 --- a/.github/ISSUE_TEMPLATE/spec-change.yml +++ /dev/null @@ -1,51 +0,0 @@ -name: Spec Change -description: Submit changes or updates to the current specification. -title: "[SPEC CHANGE]: " -labels: ["discussion topic"] -assignees: ["shawnalpay"] -body: - - type: dropdown - attributes: - label: Type of Issue - description: Select the type of spec change (e.g., Dimension, Metric, Attribute, Documentation). - options: - - 'Dimension' - - 'Metric' - - 'Attribute' - - 'Documentation' - validations: - required: true - - - type: checkboxes - attributes: - label: Normalized - description: Indicate if the dimension is normalized. - options: - - label: "Yes" - - label: "No" - validations: - required: true - - - type: textarea - attributes: - label: Description - description: Describe the issue and the changes being proposed. - placeholder: Provide a detailed description of the spec change. - validations: - required: true - - - type: textarea - attributes: - label: Definition of Done - description: Checklist of items that define the completion of the spec change. - placeholder: "- Rationalize vendor-neutral, cross-cloud naming\n- Complete spec template and include naming, constraints, guidelines\n- Include principles and governance criteria for maintaining normalized dimensions" - validations: - required: true - - - type: textarea - attributes: - label: Context / Supporting Information - description: Provide any additional context that may help in understanding or evaluating the spec change. Include mappings between normalized values and vendor-specified values if applicable. - placeholder: Additional context, references to other issues, or any relevant supporting information. - validations: - required: false diff --git a/.github/ISSUE_TEMPLATE/work-item.yml b/.github/ISSUE_TEMPLATE/work-item.yml index bc422b790..2f588c778 100644 --- a/.github/ISSUE_TEMPLATE/work-item.yml +++ b/.github/ISSUE_TEMPLATE/work-item.yml @@ -30,8 +30,7 @@ body: attributes: label: "Problem Statement" description: "Provide a detailed explanation of the problem or issue." - placeholder: "Your input here..." - value: "Provide details of the problem statement here." + placeholder: "Provide details of the problem statement here." validations: required: true @@ -47,8 +46,7 @@ body: attributes: label: "Objective" description: "Describe the expected outcome and success criteria." - placeholder: "Your input here..." - value: "Outline the expected outcome and success criteria." + placeholder: "Outline the expected outcome and success criteria." validations: required: true @@ -65,8 +63,7 @@ body: attributes: label: "Supporting Documentation" description: "Provide links to data examples, use cases, PRs, or other relevant documents." - placeholder: "Your input here..." - value: "Include links to supporting documentation, if applicable." + placeholder: "Include links to supporting documentation, if applicable." validations: required: true @@ -85,8 +82,7 @@ body: attributes: label: "Proposed Solution / Approach" description: "Outline potential solutions or approaches." - placeholder: "Your input here..." - value: "Summarize the proposed solution or approach." + placeholder: "Summarize the proposed solution or approach." - type: markdown attributes: @@ -101,8 +97,7 @@ body: attributes: label: "Epic or Theme Association" description: "Provide potential epics or themes" - placeholder: "Your input here..." - value: "Provide the rational for the Epic or Theme." + placeholder: "Provide the rational for the Epic or Theme." - type: markdown attributes: @@ -117,5 +112,4 @@ body: attributes: label: "Stakeholders" description: "List the main stakeholders for this work item." - placeholder: "Your input here..." - value: "Provide names and roles of key stakeholders." + placeholder: "Provide names and roles of key stakeholders."