Skip to content

Commit

Permalink
change epic template
Browse files Browse the repository at this point in the history
  • Loading branch information
morri-son committed Jan 14, 2025
1 parent f0103a8 commit 4dbb71a
Showing 1 changed file with 35 additions and 2 deletions.
37 changes: 35 additions & 2 deletions .github/ISSUE_TEMPLATE/epic.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,41 @@
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. -->

# Epic Title

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

View workflow job for this annotation

GitHub Actions / Lint Markdown

Multiple top-level headings in the same document [Context: "# Epic Title"]
<!-- Provide a clear, descriptive title that summarizes the large body of work -->

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

## Scope

Check failure on line 20 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: "## Scope"]
### In Scope

Check failure on line 21 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; Above] [Context: "### In Scope"]
<!-- List features/capabilities that are part of this epic -->
-

### Out of Scope
<!-- List explicitly what will not be included -->
-

## User Stories
<!-- List the main user stories that make up this epic. Each should later be created as separate issues and linked -->
- #1242 (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)

## Acceptance Criteria
<!-- List the high-level conditions that must be met for this epic to be considered complete -->
- [ ] Criteria 1
- [ ] Criteria 2

## Related Links

Check failure on line 38 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: "## Related Links"]
-

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

View workflow job for this annotation

GitHub Actions / Lint Markdown

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

## Notes
<!-- Any additional information that doesn't fit in the above categories -->

0 comments on commit 4dbb71a

Please sign in to comment.