Skip to content

chore: create issue templates for project planning #361

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

andyatmiami
Copy link

@andyatmiami andyatmiami commented May 19, 2025

related: #327

This commit creates 3 new GitHub issue templates to help with Notebooks 2.0 project planning.

As recently agreed upon in community meetings - we want to break down work into 3 hierarchical categories:

  • Epics
  • Features
  • Tasks

The templates defined in this pull request mimic the format @ederign used when initially defining work for our first "sprint" of work.

⚠️ Please note, however, I have introduced the term Task to capture the most granular issue type. Happy to change the word to something else - but wanted a [...] prefix to identify these issues similar to [EPIC] and [FEATURE]

These issue templates would not be intended to be used by "random" community members - rather they are designed to aid Epic Owners in defining work. For now, I have just added a simple "disclaimer" in the issue template summary to discourage use. In the future we could discuss extending internal-acls and leveraging GitHub Actions to ensure these "planning" templates are only used by designated community members.

Additionally, the Epic and Feature templates presently have a section to track child items included in the issue description. This accurately captures our process today but the desire in the future is to implement #325 to leverage GitHub sub-issues to more naturally track these relationships (at which point we'd remove these sections from the template).

@andyatmiami
Copy link
Author

Here is a quick preview of how this would look in the New Issue picker (simulated on a personal repo of mine)

image

related: kubeflow#327

This commit creates 3 new GitHub issue templates to help with Notebooks 2.0 project planning.

As recently agreed upon in community meetings - we want to break down work into 3 hierarchical categories:
- Epics
- Features
- Tasks

The templates defined in this pull request mimic the format @ederign used when initially defining work
for our first "sprint" of work.

:warning: Please note, however, I have introduced the term `Task` to capture the most granular issue type.  Happy to change the word to something else - but wanted a `[...]` prefix to identify these issues similar to `[EPIC]` and `[FEATURE]`

These issue templates would not be intended to be used by "random" community members - rather they are designed to aid Epic Owners in defining work.  For now, I have just added a simple "disclaimer" in the issue template summary to discourage use. In the future we could discuss extending `internal-acls` and leveraging GitHub Actions to ensure these "planning" templates are only used by designated community members.

Additionally, the `Epic` and `Feature` templates presently have a section to track child items included in the issue description.  This accurately captures our process today but the desire in the future is to implement kubeflow#325 to leverage GitHub sub-issues to more naturally track these relationships (at which point we'd remove these sections from the template).

Signed-off-by: Andy Stoneberg <[email protected]>
@andyatmiami andyatmiami force-pushed the chore/project-planning-templates branch from 0c97ea4 to a24bfa9 Compare May 20, 2025 15:52
Copy link
Member

@jenny-s51 jenny-s51 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

Copy link
Member

@ederign ederign left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a minor comment!

@@ -0,0 +1,16 @@
---
name: 🔧 Task (Planning)
about: 🛑 Only intended to be used by Kubeflow Notebooks 2.0 project managers
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Andy, a task can be created also by the project members isn't?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was viewing this use case (GH issue created by non-project member) to just be a "normal" issue opened in the repo

so a blank issue or enhancement request or whatever - but NOT this template

a project member could then always choose to add it to a feature/epic.. but i was really trying in my vision here to very clearly delineate the "planned work outlined from Epic owners" vs. "anything else that might have been created"

@google-oss-prow google-oss-prow bot added the lgtm label May 21, 2025
@ederign
Copy link
Member

ederign commented May 21, 2025

/approve

Copy link

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: ederign
Once this PR has been reviewed and has the lgtm label, please assign thesuperzapper for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@ederign
Copy link
Member

ederign commented May 21, 2025

/ok-to-test

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Needs Triage
Development

Successfully merging this pull request may close these issues.

3 participants