From 7f85d9b7c08feaf5242282aa85e3d26fae6b9e84 Mon Sep 17 00:00:00 2001 From: han-so1omon Date: Tue, 3 Jan 2023 17:43:32 -0600 Subject: [PATCH] Add new Issue Templates Add task and user-story --- .github/ISSUE_TEMPLATE/task.md | 39 ++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/user-story.md | 24 +++++++++++++++++ 2 files changed, 63 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/task.md create mode 100644 .github/ISSUE_TEMPLATE/user-story.md diff --git a/.github/ISSUE_TEMPLATE/task.md b/.github/ISSUE_TEMPLATE/task.md new file mode 100644 index 0000000..3862d96 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/task.md @@ -0,0 +1,39 @@ +--- +name: Task +about: Individual to-do +title: '' +labels: '' +assignees: '' + +--- + +### What needs to be done + +Describe what needs to be done here. + +Ex: "Relay synchronization starts from the most recently stored block header" + +### Why it needs to be done + +Describe why it needs to be done here. + +Ex: "Reduces the amount of time for the relay to synchronize to the latest block" + +### Tests + +Link associated tests here + +### Stories + +Link associated stories here + +### Acceptance Criteria + +Describe how we can know whether the task is done. + +Ex: +- When restarting the relay, synchronization picks up from the most recently stored block + +### Additional Information + +Describe anything relevant that hasn't been mentioned yet. diff --git a/.github/ISSUE_TEMPLATE/user-story.md b/.github/ISSUE_TEMPLATE/user-story.md new file mode 100644 index 0000000..e652cc7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/user-story.md @@ -0,0 +1,24 @@ +--- +name: User Story +about: Describe a user story +title: '' +labels: '' +assignees: '' + +--- + +## Overview + +A clear and concise description of the user and their need + +## Story + +As a [persona], I want [goal] so that [reason] + +## Test Scenarios +Link given/when/then test scenarios here + +## Acceptance Criteria + +- Functional acceptance criteria to be met +- Non-functional acceptance criteria to be met