From 3bb9e6fd37b95f528bbbd1857b4a8b15b4c35d36 Mon Sep 17 00:00:00 2001 From: Steven Folsom Date: Thu, 7 Aug 2025 12:08:08 -0400 Subject: [PATCH 1/2] Update big-use-case-user-story.md --- .../ISSUE_TEMPLATE/big-use-case-user-story.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/big-use-case-user-story.md b/.github/ISSUE_TEMPLATE/big-use-case-user-story.md index a1dbcb1..1d48af0 100644 --- a/.github/ISSUE_TEMPLATE/big-use-case-user-story.md +++ b/.github/ISSUE_TEMPLATE/big-use-case-user-story.md @@ -9,32 +9,32 @@ assignees: '' ## Use case overview - **Priority**: [High/Medium/Low] -- **Status**: [Draft/Under Review/Approved/Implemented] +- **Status**: [Use appropriate GitHub label when creating Issue, Draft/Ready for Review/Under Review/Approved/Implemented] ## Describe use case -A clear and concise description of a use case supported by BIG outputs (DCTAP and/or SHACL). +_A clear and concise description of a use case supported by BIG outputs (DCTAP and/or SHACL)._ E.g. *As a cataloger using a BIBFRAME editor, I would like the editor to check that my description validates using the BIG shapes without any errors* ## Preconditions (Optional) -List conditions that must be true before this use case can begin. +_List conditions that must be true before this use case can begin. Please list any blockers for this use case._ ## Describe expected behavior in related systems -A clear and concise description of related system behavior +_A clear and concise description of related system behavior_ E.g. *Using the BIG SHACL, the editor would compare the description provided by the cataloger against the applicable BIG SHACL before saving the data. If the description does not confirm to BIG shape definitions, the cataloger would not be allowed to save the description and would be notified which fields in the editors are missing or require changes* ## Post conditions (Optional) ### Success post conditions -What should be true after successful completion? +_What should be true after successful completion?_ ### Failure post conditions -What should be true if the use case fails? +_What should be true if the use case fails?_ ## Main success scenario -What steps or conditions would this use case be considered to be a success? +_What steps or conditions would this use case be considered to be a success?_ ## Additional context -Add any other context or screenshots about the features you are requesting. +_Add any other context or screenshots about the features you are requesting._ E.g. *Using SHACL for validation in BIBFRAME editors like Sinopia and Marva has overlap with template creation in those systems* From 5de30ec8acc84e091e9f9116a9e7e835eb3c1dc9 Mon Sep 17 00:00:00 2001 From: Steven Folsom Date: Thu, 4 Sep 2025 11:32:56 -0400 Subject: [PATCH 2/2] Update big-use-case-user-story.md --- .github/ISSUE_TEMPLATE/big-use-case-user-story.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/big-use-case-user-story.md b/.github/ISSUE_TEMPLATE/big-use-case-user-story.md index 1d48af0..65e231c 100644 --- a/.github/ISSUE_TEMPLATE/big-use-case-user-story.md +++ b/.github/ISSUE_TEMPLATE/big-use-case-user-story.md @@ -9,7 +9,7 @@ assignees: '' ## Use case overview - **Priority**: [High/Medium/Low] -- **Status**: [Use appropriate GitHub label when creating Issue, Draft/Ready for Review/Under Review/Approved/Implemented] +- **Status**: [Use appropriate GitHub label when creating Issue, e.g. question, help wanted, Ready for Review] ## Describe use case _A clear and concise description of a use case supported by BIG outputs (DCTAP and/or SHACL)._ @@ -17,7 +17,7 @@ _A clear and concise description of a use case supported by BIG outputs (DCTAP a E.g. *As a cataloger using a BIBFRAME editor, I would like the editor to check that my description validates using the BIG shapes without any errors* ## Preconditions (Optional) -_List conditions that must be true before this use case can begin. Please list any blockers for this use case._ +_List conditions that must be true before this use case can begin. Please list any known blockers for this use case._ ## Describe expected behavior in related systems _A clear and concise description of related system behavior_