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.

Sign up for GitHub

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

chore: change epic template #1255

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

chore: change epic template #1255

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
4dbb71a
change epic template
morri-son Jan 14, 2025
e1bdf85
Update epic.md
morri-son Jan 14, 2025
88d735f
Update epic.md
morri-son Jan 14, 2025
a9ad304
Update epic.md
morri-son Jan 14, 2025
ce327d5
Update epic.md
morri-son Jan 14, 2025
bea7bf4
Merge branch 'main' into change-epic-template
morri-son Jan 15, 2025
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
36 changes: 34 additions & 2 deletions .github/ISSUE_TEMPLATE/epic.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,40 @@
name: Epic
about: Create a new Epic
labels: kind/epic
title: <Epic> - Title
---

<!-- markdownlint-disable MD041 -->
**Description**
This is a short text that just acts as an example for your epic. Please be as precise and verbose as required, so that people understand what larger picture the epic should frame.
<!-- This is a short text that just acts as an example for your epic. Please be as precise and verbose as required, so that people understand what larger picture the epic should frame. -->
## Goal

Describe the overall objective and value proposition
<!-- -->
As a [user type],
I want [capability/feature],
so that [business value/benefit]

## Scope

### In Scope

List features/capabilities that are part of this epic

-

### Out of Scope

List explicitly what will not be included

-

## User Stories

Check failure on line 32 in .github/ISSUE_TEMPLATE/epic.md

View workflow job for this annotation

GitHub Actions / Lint Markdown 

Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "## User Stories"]
List the main user stories that make up this epic. Each should later be created as separate issues and linked (just mention the number of the related user stories here (if in another repo add org and repo as prefix, e.g. open-component-model/ocm#1105), it will appear as clickable link later)
- #1242

Check failure on line 34 in .github/ISSUE_TEMPLATE/epic.md

View workflow job for this annotation

GitHub Actions / Lint Markdown 

Lists should be surrounded by blank lines [Context: "- #1242"]

## Acceptance Criteria

Check failure on line 36 in .github/ISSUE_TEMPLATE/epic.md

View workflow job for this annotation

GitHub Actions / Lint Markdown 

Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "## Acceptance Criteria"]
List the high-level conditions that must be met for this epic to be considered complete
- [ ] Criteria 1

Check failure on line 38 in .github/ISSUE_TEMPLATE/epic.md

View workflow job for this annotation

GitHub Actions / Lint Markdown 

Lists should be surrounded by blank lines [Context: "- [ ] Criteria 1"]
- [ ] Criteria 2

## Additional Links and Notes
Loading