Skip to content

Commit

Permalink
Update epic.md
Browse files Browse the repository at this point in the history
  • Loading branch information
morri-son authored Jan 14, 2025
1 parent 4dbb71a commit e1bdf85
Showing 1 changed file with 12 additions and 15 deletions.
27 changes: 12 additions & 15 deletions .github/ISSUE_TEMPLATE/epic.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,36 +7,33 @@ title: <Epic> - Title

<!-- markdownlint-disable MD041 -->
<!-- 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
<!-- Provide a clear, descriptive title that summarizes the large body of work -->

## Epic Goal
<!-- Describe the overall objective and value proposition -->

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 -->

List features/capabilities that are part of this epic

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

View workflow job for this annotation

GitHub Actions / Lint Markdown

Heading style [Expected: atx; Actual: setext]
-

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

List explicitly what will not be included

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

View workflow job for this annotation

GitHub Actions / Lint Markdown

Heading style [Expected: atx; Actual: setext]
-

## User Stories

Check failure on line 30 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 -->
- #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)
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 32 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 34 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 -->
List the high-level conditions that must be met for this epic to be considered complete
- [ ] Criteria 1

Check failure on line 36 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

## Related Links
-

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

0 comments on commit e1bdf85

Please sign in to comment.