-
Notifications
You must be signed in to change notification settings - Fork 4
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
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
3be7eaf
feat: add a use cases template for github issues
laurensdeb adfc32b
feat: apply suggestions from review
laurensdeb 97fef07
feat: apply suggestions from review
laurensdeb 66f8fd9
chore: remove assignees
laurensdeb b30c2f9
Update .github/ISSUE_TEMPLATE/use-case.md
hzbarcea File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
|
||
--- | ||
|
||
**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.* |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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?