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

feat: add a use cases template for github issues #5

Merged
merged 5 commits into from
Nov 12, 2024
Merged
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
46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/use-case.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
name: Use Case
about: Use this template to propose an LWS use case.
title: "[UC] <<brief description of use case>>"
labels: triage, usecase

---

Choose a reason for hiding this comment

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

Maybe add a clarification for the mandatory status for each section (either here or at the section heading)? Or are all fields mandatory for the first draft?

**As a [primary actor],**
**I want [an action or feature],**
**So that [a reason or benefit].**

## Preconditions:

*What conditions must be in place or assumed before this use case can begin?*

## Trigger:

*What (user or system) event or action initiates this use case?*

## Actors:

*Describe the primary actor, and any other relevant actors involved in this use case*

## Distinction:

*What unique challenges or distinguishing factors (like technical issues, user experience needs, workflow integration, etc.) are associated with this use case?*

## Scenario:

*Describe an ideal or happy-case scenario where this use case would play out as intended.*

## Alternative case(s):

*What alternative flows or variations should the system handle for this use case?*

hzbarcea marked this conversation as resolved.
Show resolved Hide resolved
## Error scenario:

*What unexpected issues or errors might arise, and how should the system handle them?*
## Acceptance Criteria:

*What conditions or criteria must be met for this use case to be considered successfully handled? What limitations are acceptable?*

## References:

*List any relevant resources or examples that could inform this use case, possibly from other domains or solutions.*