-
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
Conversation
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.
LGTM
First of all, great to see this moving. More than happy to convert my existing ones following a template.
|
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.
Added some clarifications and suggestions for group's consideration.
Perhaps instead of or in addition to "assignee", the proposer should indicate things along these lines. So this could be integrate into the template:
- will implement potential solutions
- will share implementation experience
- will share code implementing the requirements that come out of this use case
.github/ISSUE_TEMPLATE/use-case.md
Outdated
about: Use this template to propose an LWS use case. | ||
title: "[UC] <<brief description of use case>>" | ||
labels: triage, usecase | ||
assignees: '' |
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.
I'm not sure I understand this in the template.
assignees: '' | |
assignees: '' |
LGTM, and support csarven's suggestions |
Co-authored-by: Sarven Capadisli <info@csarven.ca> Co-authored-by: Ted Thibodeau Jr <tthibodeau@openlinksw.com>
Co-authored-by: Sarven Capadisli <info@csarven.ca>
@renyuneyun This is still a first revision of the use case template, I'm sure when actually using it for the concrete use cases it will still need some refinement. To answer your questions:
I would interpret preconditions quite broadly, these could also refer to other use cases. For example, "a user must have a LWS-compliant storage server" or "a resource must have been created in the storage server".
Typically I see a use case as something which is triggered by a particular event. For example, a user stores a resource in a LWS-compliant storage server such that it can be shared or retrieved later on (the use case) by performing an HTTP request to the storage server (a possible trigger for the use case, of which there can be several).
Alternative cases are instances of a use case which differ from the "happy case" scenario in a significant way, because some exception has occured during the happy scenario for example. For example, an IdP is unavailable for the storage server when trying to authenticate a client, how might we handle such a scenario. |
labels: triage, usecase | ||
|
||
--- | ||
|
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?
Co-authored-by: Sarven Capadisli <info@csarven.ca>
This is a proposal for a Github issues template for use cases for the LWS WG, all feedback is welcome.
The template was loosely inspired on
VC Use Cases
DID Use Cases
WOT Use Cases