From 3330cc405a731c9cd0f1f2e90e015763e67ee725 Mon Sep 17 00:00:00 2001 From: Joaquin Date: Mon, 15 Jul 2024 20:20:17 +0200 Subject: [PATCH] [REPO] Enhance Issue Templates (#490) ### Enhance Template: `issue feedback ` This addition explicitly requests users to provide relevant data or data extracts along with their feedback. It emphasizes the importance of data in supporting discussions and decision-making while reminding submitters to ensure that the data is anonymized and compliant with privacy guidelines. ### Enhance Template: `discussion Topic` This YAML replaces the previous `discussion-topic.md` file. It defines the structure and content of the GitHub issue form for discussing broad topics within the FOCUS community. It ensures that all necessary information is gathered effectively, including an optional field for attaching relevant data, which will support the discussion with tangible examples. ### Enhance Template: `maintenance` This YAML template is structured to gather essential information about maintenance tasks within the GitHub repository or actions. The format ensures clarity and specificity in the task descriptions and outcomes, facilitating effective task management and completion. ### Enhance Template: `spec-change` This template provides a YAML format for submitting specification changes, ensuring that all relevant information is captured, including the type of issue, whether the issue is normalized, a detailed description, a clear definition of what constitutes completion of the task, and an optional section for additional context or supporting information. This approach ensures clarity and facilitates the efficient management of specification changes. --- .github/ISSUE_TEMPLATE/discussion-topic.yml | 45 ++++++++++++++++++ .github/ISSUE_TEMPLATE/feedback.yml | 10 +++- .github/ISSUE_TEMPLATE/maintenance.yml | 21 +++++++++ .github/ISSUE_TEMPLATE/spec-change.md | 1 - .github/ISSUE_TEMPLATE/spec_change.yml | 51 +++++++++++++++++++++ 5 files changed, 126 insertions(+), 2 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/discussion-topic.yml create mode 100644 .github/ISSUE_TEMPLATE/maintenance.yml create mode 100644 .github/ISSUE_TEMPLATE/spec_change.yml diff --git a/.github/ISSUE_TEMPLATE/discussion-topic.yml b/.github/ISSUE_TEMPLATE/discussion-topic.yml new file mode 100644 index 000000000..04310627b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/discussion-topic.yml @@ -0,0 +1,45 @@ +name: Discussion Topic +description: Initiate discussion on broad topics within the FOCUS community. +title: "[DISCUSSION]: " +labels: ["discussion topic"] +assignees: ["mike-finopsorg,udam-f2"] +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.yml b/.github/ISSUE_TEMPLATE/feedback.yml index 8ec5572b6..1ab51c5c0 100644 --- a/.github/ISSUE_TEMPLATE/feedback.yml +++ b/.github/ISSUE_TEMPLATE/feedback.yml @@ -1,7 +1,7 @@ name: FinOps Use Case Feedback description: Provide feedback on FinOps use cases that cannot be performed with the current FOCUS specification. title: "[FEEDBACK]: " -labels: ["feedback", "use-case"] +labels: [""] assignees: ["mike-finopsorg,udam-f2"] body: - type: markdown @@ -59,3 +59,11 @@ body: validations: required: true + - type: textarea + 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. + validations: + required: false + diff --git a/.github/ISSUE_TEMPLATE/maintenance.yml b/.github/ISSUE_TEMPLATE/maintenance.yml new file mode 100644 index 000000000..3a39989ce --- /dev/null +++ b/.github/ISSUE_TEMPLATE/maintenance.yml @@ -0,0 +1,21 @@ +name: Maintenance Task +description: Create tasks related to work on the GitHub Repository or GitHub Actions. +title: "[MAINTENANCE]: " +labels: ["repo maintenance"] +assignees: ["mike-finopsorg,udam-f2"] +body: + - type: textarea + attributes: + label: Description + description: Describe the maintenance issue that needs to be addressed. + placeholder: Provide a detailed description of the maintenance task here. + validations: + required: true + + - type: textarea + attributes: + label: Definition of Done + description: Describe the outcomes that will indicate the task has been successfully completed. + placeholder: Specify what 'done' looks like for this task. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/spec-change.md b/.github/ISSUE_TEMPLATE/spec-change.md index 9d1b5f284..0e8003855 100644 --- a/.github/ISSUE_TEMPLATE/spec-change.md +++ b/.github/ISSUE_TEMPLATE/spec-change.md @@ -4,7 +4,6 @@ about: Spec change issue title: Spec Change title labels: spec change assignees: '' - --- ### Type diff --git a/.github/ISSUE_TEMPLATE/spec_change.yml b/.github/ISSUE_TEMPLATE/spec_change.yml new file mode 100644 index 000000000..344bdcc8c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/spec_change.yml @@ -0,0 +1,51 @@ +name: Spec Change +description: Submit changes or updates to the current specification. +title: "[SPEC CHANGE]: " +labels: ["discussion topic"] +assignees: ["mike-finopsorg,udam-f2"] +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