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

Conversation

laurensdeb
Copy link
Contributor

@laurensdeb laurensdeb commented Oct 28, 2024

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

@laurensdeb laurensdeb self-assigned this Oct 28, 2024
Copy link
Member

@acoburn acoburn left a comment

Choose a reason for hiding this comment

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

LGTM

@renyuneyun
Copy link

renyuneyun commented Oct 29, 2024

First of all, great to see this moving. More than happy to convert my existing ones following a template.
But I do have questions (see below) on the template itself, from a newbie's perspective. Hope more explanations or examples are added, or template being revised.

  1. Does "precondition" refer to preconditions in terms of features or other use cases, or precondition of the exact use case (e.g. what types of data are stored in the Pod, and then the use case exists)?
  2. What does "trigger" really mean? Why and how is it different from the scenario itself?
  3. What should be included in "alternative cases"? In particular, do they refer to "alternative use cases (which may fulfil the same / comparable functionality of this use case)"?

Copy link
Member

@csarven csarven left a 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 Show resolved Hide resolved
.github/ISSUE_TEMPLATE/use-case.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/use-case.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/use-case.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/use-case.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/use-case.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/use-case.md Show resolved Hide resolved
.github/ISSUE_TEMPLATE/use-case.md Outdated Show resolved Hide resolved
about: Use this template to propose an LWS use case.
title: "[UC] <<brief description of use case>>"
labels: triage, usecase
assignees: ''
Copy link
Member

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.

Suggested change
assignees: ''
assignees: ''

@chrisn
Copy link
Member

chrisn commented Nov 4, 2024

LGTM, and support csarven's suggestions

laurensdeb and others added 3 commits November 8, 2024 16:51
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>
@laurensdeb
Copy link
Contributor Author

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

Does "precondition" refer to preconditions in terms of features or other use cases, or precondition of the exact use case
(e.g. what types of data are stored in the Pod, and then the use case exists)?

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

What does "trigger" really mean? Why and how is it different from the scenario itself?

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

What should be included in "alternative cases"? In particular, do they refer to "alternative use cases (which may fulfil the
same / comparable functionality of this use case)"?

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.

@laurensdeb
Copy link
Contributor Author

@csarven I've updated the pull request to reflect your proposed changes.

@hzbarcea I've understood from @acoburn that you would be finalizing the template, so I've added you as assignee. If you need any further input from my side, let me know. Else, I will leave this PR for you to merge or close.

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?

Co-authored-by: Sarven Capadisli <info@csarven.ca>
@hzbarcea hzbarcea merged commit ecd586b into main Nov 12, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants