From ceaaf630f244c3d7641adae6be3feeb45bbf568b Mon Sep 17 00:00:00 2001 From: Henry Wilkinson Date: Sun, 27 Aug 2023 19:34:04 -0400 Subject: [PATCH] dev: GitHub Issue form update: updates "user story" title (#1112) - Updates user story title - User story title should be friendlier to those who don't know what a "user story" is! - Clarifies sections that shouldn't be edited by users in the preview text - Adds note about reporting security vulnerabilities --------- Co-authored-by: sua yoo --- .github/ISSUE_TEMPLATE/config.yml | 2 ++ .github/ISSUE_TEMPLATE/feature-change.yml | 15 +++++++++++---- 2 files changed, 13 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index fbdc70f4..62df921e 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -2,6 +2,8 @@ blank_issues_enabled: true contact_links: + - name: Report a security vulnerability + about: Please do not file an issue and instead email security@webrecorder.org. We will follow up with you there! - name: Get help on our forum url: https://forum.webrecorder.net/ about: Have a ("how do I...?") question? Not sure if your issue is reproducible? The best way to get help is on our community forum! diff --git a/.github/ISSUE_TEMPLATE/feature-change.yml b/.github/ISSUE_TEMPLATE/feature-change.yml index 20aeb2e5..2f171eba 100644 --- a/.github/ISSUE_TEMPLATE/feature-change.yml +++ b/.github/ISSUE_TEMPLATE/feature-change.yml @@ -14,7 +14,8 @@ body: # User story sentence - type: textarea attributes: - label: User Story Sentence + label: What change would you like to see? + description: Describe the solution you'd like. If relevant, include ways in which you've tried to solve the issue with the current version. placeholder: "As a user, I want to be able to ____ so that I can ____" validations: required: true @@ -22,17 +23,23 @@ body: - type: textarea attributes: label: Requirements - description: List the outcomes of the feature being implemented without design or implementation details. + description: | + Intended primarily for use by Webrecorder team, leave blank if unknown. + + List the outcomes of the feature being implemented without design or implementation details. placeholder: | 1. Item metadata should show links to the collections that the item belongs to. 2. Items can be added or removed from collections when editing an item. validations: - required: true + required: false # Todo - type: textarea attributes: label: Todo - description: Any other linked issues / tasks to complete to implement this feature (leave blank if unknown). + description: | + Intended primarily for use by Webrecorder team, leave blank if unknown. + + Any other linked issues / tasks to complete to implement this feature. placeholder: | - [ ] Mockups: - [ ] Design: