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

Update Issue templates #383

Merged
merged 1 commit into from
Apr 19, 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
52 changes: 52 additions & 0 deletions .github/ISSUE_TEMPLATE/01-action.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
name: Tracking/Action Item
description: Use this issue type to track and manage any actions that require a significant amount of time to complete. Avoid using this issue type for tasks expected to be closed within hours.
title: "[<Tracking>/<Action>] <some descriptive title>"
labels: ["issue/needs-triage", "board/unassigned"]
projects: ["cncf/10"]
body:
- type: markdown
attributes:
value: |
Thank you for contributing to the TAG!
Please remember that an issue is not the place to ask a question.
The README documents how to reach us https://github.com/cncf/tag-env-sustainability#contact
Thank you :)
- id: description
type: textarea
attributes:
label: Description
description: What is your activity about? Describe the action item here.
validations:
required: true
- id: outcome
type: textarea
attributes:
label: Outcome
description: What do you want to achieve and share with the community?
validations:
required: true
- id: todo
type: textarea
attributes:
label: To-Do
description: What specific actions do you need to do to implement it?
value: |
- [ ] ...
validations:
required: false
- id: coc
type: checkboxes
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://www.cncf.io/conduct/).
options:
- label: I agree to follow this project's Code of Conduct
required: true
- id: comments
type: textarea
attributes:
label: Comments
description: Space to add any other comments, refer to people, or provide additional details.
placeholder: None
validations:
required: false
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/02-bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Bug Report
description: File a bug report.
title: "[BUG] <some descriptive title>"
labels: ["issue/needs-triage", "board/unassigned"]
projects: ["cncf/10"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Also tell us, what did you expect to happen?
placeholder: Tell us what you see!
value: "A bug happened!"
validations:
required: true
- id: coc
type: checkboxes
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://www.cncf.io/conduct/).
options:
- label: I agree to follow this project's Code of Conduct
required: true
- id: comments
type: textarea
attributes:
label: Comments
description: Space to add any other comments, refer to people, or provide additional details.
placeholder: None
validations:
required: false
96 changes: 96 additions & 0 deletions .github/ISSUE_TEMPLATE/04-project-suggestion.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
name: Project Proposal / Suggestion
description: Idea for a new project that will improve or enhance the TAG Environmental Sustainability. Choose "Proposal" if you intend to implement the idea, otherwise name it "Suggestion".
title: "[PROJECT <PROPOSAL> / <SUGGESTION>] <some descriptive title>"
labels: ["board/unassigned", "issue/needs-triage"]
projects: ["cncf/10"]
body:
- type: markdown
attributes:
value: |
Thank you for opening this proposal! If you personally want to lead the project, call it a "proposal", if not, call it a "suggestion". If you want to lead the project, it is much more likely that the proposal will be accepted!
- id: description
type: textarea
attributes:
label: Description
description: Describe your idea here.
validations:
required: true
- id: impact
type: textarea
attributes:
label: Impact
description: Describe your hopes for how this would reduce risk for the cloud native ecosystem. Who will this help? How will it help them?
validations:
required: true
- id: scope
type: textarea
attributes:
label: Scope
description: Define what is in scope and out of scope for this project.
value: |
**In Scope**: ...

**Out of Scope**: ...
validations:
required: true
- id: goals
type: textarea
attributes:
label: Goals and Non-Goals
description: Outline the goals and non-goals for this project.
value: |
**Goals**: ...

**Non Goals**: ...
validations:
required: true
- id: deliverables
type: textarea
attributes:
label: Deliverables
description: List the artifacts to be created to complete this project (e.g., blogs, whitepapers, documentation, videos).
value: |
- ...
validations:
required: true
- id: additional_info
type: textarea
attributes:
label: Additional Info and Comments
description: Provide any additional information or comments about the project. Like supporting material, related links etc.
validations:
required: false
- id: todo
type: checkboxes
attributes:
label: To-Do List
description: Check off the following tasks as you complete them.
options:
- label: "Project proposal / suggestion details added to this issue."
required: true
- label: "Project Leads found (link project leads here)."
required: false
- label: "Project proposal discussed in the TAG."
required: false
- label: "Project proposal accepted / rejected by the TAG leads."
required: false
- label: "Project sponsor found (TAG Chair / TAG TL)."
required: false
- label: "Project tracking issue opened (see templates)."
required: false
- id: coc
type: checkboxes
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://www.cncf.io/conduct/).
options:
- label: I agree to follow this project's Code of Conduct
required: true
- id: comments
type: textarea
attributes:
label: Comments
description: Space to add any other comments about the proposal/suggestion.
value: cc @cncf/tag-env-sustainability
validations:
required: false
143 changes: 143 additions & 0 deletions .github/ISSUE_TEMPLATE/05-project-tracking.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,143 @@
name: Project Tracking
description: Use this template to track the ongoing progress of an accepted project proposal or suggestion within the TAG Environmental Sustainability.
title: "[PROJECT TRACKING] <some descriptive title>"
projects: ["cncf/10"]
labels: ["board/tag", "issue/tracking", "issue/needs-triage"]
body:
- type: markdown
attributes:
value: |
Thank you for contributing to the TAG!
Please remember that an issue is not the place to ask a question.
The README documents how to reach us https://github.com/cncf/tag-env-sustainability#contact
Thank you :)
- type: markdown
attributes:
value: |
If you personally want to lead the project, call it a "proposal", IF NOT, call it a "suggestion". If you want to lead the project, it is much more likely that the proposal will be accepted!
- id: description
type: textarea
attributes:
label: Description
description: Describe your idea here.
validations:
required: true
- id: impact
type: textarea
attributes:
label: Impact
description: Describe your hopes for how this would reduce risk for the cloud native ecosystem. Who will this help? How will it help them?
validations:
required: true
- id: scope
type: textarea
attributes:
label: Scope
description: Define what is in scope and out of scope for this project.
value: |
**In Scope**: ...

**Out of Scope**: ...
validations:
required: true
- id: goals
type: textarea
attributes:
label: Goals and Non-Goals
description: Outline the goals and non-goals for this project.
value: |
**Goals**: ...

**Non Goals**: ...
validations:
required: true
- id: deliverables
type: textarea
attributes:
label: Deliverables
description: List the artifacts to be created to complete this project (e.g., blogs, whitepapers, documentation, videos).
value: |
- ...
validations:
required: true
- id: additional_info
type: textarea
attributes:
label: Additional Info and Comments
description: Provide any additional information or comments about the project. Like supporting material, related links etc.
validations:
required: false
- id: project_details
type: textarea
attributes:
label: Project Details
description: |
Provide details about the project leads, TAG ENV lead representative, project timeline, drive folder, and meeting details.
value: |
- **Project Leads**: ...
- **TAG ENV Lead Representative**: ...
- **Project Started**: XX-XX-XX
- **Project Completed At**: XX-XX-XX
- **Project Drive Folder**: ...
- **Meeting Details**: ...
- *link*: `password`
- Meeting Notes: link
- Schedule: *every two weeks on Thursday* see [calendar](https://calendar.google.com/calendar/embed?src=72e93a411f02e5664bb4485c04311b83dae6a62574e4ab882a1ccf8526aa9bf1%40group.calendar.google.com)
- Past Meetings:
- XX-XX: meeting title - YT recording link
- id: todo
type: checkboxes
attributes:
label: To-Do List starting the project
description: Check off the following tasks as you complete them.
options:
- label: "Project details added to this issue."
required: true
- label: "Slack Channel created (if needed)."
required: false
- label: "Project Google Drive folder and meeting notes document created. Information added to the this issue."
required: false
- label: "Meeting Time & Day scheduled. Information added to the this issue."
required: false
- id: updates_to_tag
type: textarea
attributes:
label: Ongoing Project Updates to TAG ENV
description: This list is used to record the updates that are communicated to the TAG via the project development.
value: |
<!-- Format:
- Update given on *YYYY-MM-DD*: <summary>
-->
- *No update given yet*
- id: todo_closing
type: checkboxes
attributes:
label: Tasks after completion of the project deliverables and conclusion of the project.
description: Check off the following tasks as you complete them.
options:
- label: "Reached out to the TAG Lead representative to complete the project deliverables."
required: false
- label: "TAG Lead commented under this issue about checking the deliverables"
required: false
- label: "Deliverables releases to the community if applicable"
required: false
- label: "Project retrospective issue opened opened (see issue templates)"
required: false
- label: "Project retrospective completed"
required: false
- id: coc
type: checkboxes
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://www.cncf.io/conduct/).
options:
- label: I agree to follow this project's Code of Conduct
required: true
- id: comments
type: textarea
attributes:
label: Comments
description: Space to add any other comments about the tracking of this project.
value: cc @cncf/tag-env-sustainability
validations:
required: false
46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/07-retrospective.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: Retrospective
description: Retrospective issue to reflect on a project, presence of the TAG at an event, or any other matter.
title: "[RETRO] <some descriptive title>"
labels: ["kind/retrospective", "issue/needs-triage", "board/unassigned"]
projects: ["cncf/10"]
body:
- type: markdown
attributes:
value: |
Thank you for contributing to the TAG!
Please remember that an issue is not the place to ask a question.
The README documents how to reach us https://github.com/cncf/tag-env-sustainability#contact
Thank you :)
- id: retro_schema
type: textarea
attributes:
label: Schema of the retrospective
value: |
This tracking issue is used to collect async retro items from anyone of `PROJECT NAME`.

Please use the following template to leave feedback:

* **KEEP DOING**:
* **MORE OF**:
* **START DOING**:
* **STOP DOING**:
* **LESS OF**:
* **IDEAS**:

We will discuss anything added to the issue in the upcoming retro meeting on `XX-XX` and report on the results in the TAG Meeting on `XX-XX`.
- id: coc
type: checkboxes
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://www.cncf.io/conduct/).
options:
- label: I agree to follow this project's Code of Conduct
required: true
- id: comments
type: textarea
attributes:
label: Comments
description: Space to add any other comments about the blog post
value: cc @cncf/tag-env-sustainability
validations:
required: false
Loading
Loading