generated from decentralized-identity/template-for-WGs
-
Notifications
You must be signed in to change notification settings - Fork 3
Bumblefudge/add-usecase-template #2
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
Merged
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
34b8087
first draft
bumblefudge 7af038c
fine-tuning
bumblefudge fb3627e
update
bumblefudge 0e76787
linters gonna lint
bumblefudge af0644f
Update .github/ISSUE_TEMPLATE/use-case.md
bumblefudge 18d4799
Update .github/ISSUE_TEMPLATE/use-case.md
bumblefudge aeffb7c
Update .github/ISSUE_TEMPLATE/use-case.md
bumblefudge 1d67e73
incorporate feedback and number subsections of ##Flow to clarify rela…
bumblefudge 33f7ed6
Merge branch 'bumblefudge/add-usecase-template' of https://github.com…
bumblefudge 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 hidden or 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,81 @@ | ||
| --- | ||
| name: Use Case | ||
| about: Use this template to propose a use case be elaborated collectively. | ||
| title: "[UC] <<brief description of use case>>" | ||
| champion: <<Name>> ( <<github handle>> ) | ||
| labels: usecase | ||
bumblefudge marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| tags: [ <<tag 1>>, <<tag 2...>>] | ||
|
|
||
| --- | ||
|
|
||
| ## Summary | ||
|
|
||
| _<!-- Insert Title Here -->_ | ||
|
|
||
| ### Driving User Story | ||
|
|
||
| **As a [primary actor],** | ||
| **I want [an action or feature],** | ||
| **With [additional requirement or side-effect],** | ||
| **So that [a reason or benefit].** | ||
|
|
||
| ## Context | ||
|
|
||
bumblefudge marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - [ ] I have looked for similar use cases and feel this issue is a distinct use-case, rather than best encoded as a variant or "alternate path" to an existing one. | ||
|
|
||
| ### Related Use Cases | ||
|
|
||
| <--! Leave empty if none; otherwise, a bullet list is best, whether annotated or not. --> | ||
|
|
||
| ### Terminology | ||
|
|
||
| <!-- If you use any terms differently or more precisely than usual --> | ||
|
|
||
| ### Actors | ||
|
|
||
| <!-- Enumerate every actor, server, service, process that will take an action or reaction, including storage, forwarding, etc. | ||
| Optionally, mark one actor as primary. --> | ||
|
|
||
| ### Other Stakeholders | ||
bumblefudge marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| <!-- e.g. auditors, regulators, forensic accountants, martian anthropologists, etc. --> | ||
|
|
||
| ## Flows | ||
|
|
||
| <!-- Feel free to write "TBD" or "N/A" for any subsections you don't have a clear answer for year, but don't remove them, it's a helpful reminder for later. --> | ||
|
|
||
| ### 0 - Preconditions | ||
|
|
||
| <!-- What conditions must be in place or assumed before this use case can begin? --> | ||
bumblefudge marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ### 1 - Trigger | ||
|
|
||
| <!-- What (user or system) event or action initiates this use case? --> | ||
|
|
||
| ### 2A - Happy Path | ||
|
|
||
| ### 2B - Alternative Paths | ||
|
|
||
| <!-- Feel free to not just list these at a high level, but name these and add a #### heading for each, now or later --> | ||
|
|
||
| ### 3A - Challenges and Key Risks | ||
|
|
||
| <!-- Can be failure modes/conditions or just more qualitative issues that affect satisfaction/safety less definitively. | ||
| Feel free to not just list these at a high level, but name these and add a #### heading for each, now or later --> | ||
|
|
||
| ### 3B - Success Criteria | ||
|
|
||
| <!-- What conditions or criteria must be met for this use case to be considered successfully handled? What limitations are acceptable? | ||
| To put it another way, what observable behaviors or metrics can be used to detect a failure more, or differentiate happy paths-or-outcomes from less-happy paths-or-outcomes? --> | ||
|
|
||
| ### 3C - Acceptable Outcomes | ||
|
|
||
| <!-- Distinct from whether or not a flow was succesful or which outcome, what are the minimally required outcomes or side-effects (e.g. logs) across all outcomes. --> | ||
|
|
||
| ## References | ||
|
|
||
| ### Prior Art | ||
|
|
||
| <!-- Highly recommend including links to blog posts, case studies, thought experiments, and prototypes that influenced this idea, including your own! good to have a [timestamped] snapshot if you want bragging rights about your input to the collective process 😉 --> | ||
|
|
||
| ### Annotated Bibliography | ||
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.
Uh oh!
There was an error while loading. Please reload this page.