Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[REPO] Enhance Issue Templates #490

Merged
merged 9 commits into from
Jul 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions .github/ISSUE_TEMPLATE/discussion-topic.yml
Original file line number Diff line number Diff line change
@@ -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
10 changes: 9 additions & 1 deletion .github/ISSUE_TEMPLATE/feedback.yml
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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

21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/maintenance.yml
Original file line number Diff line number Diff line change
@@ -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
1 change: 0 additions & 1 deletion .github/ISSUE_TEMPLATE/spec-change.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ about: Spec change issue
title: Spec Change title
labels: spec change
assignees: ''

---

### Type
Expand Down
51 changes: 51 additions & 0 deletions .github/ISSUE_TEMPLATE/spec_change.yml
Original file line number Diff line number Diff line change
@@ -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
Loading