From 5e91c7ebc2a409d2f3080fc045d2950ba7d706d5 Mon Sep 17 00:00:00 2001 From: Henry Wilkinson Date: Tue, 21 Nov 2023 21:36:32 -0500 Subject: [PATCH 1/3] Adds a GitHub issue template for replay problems --- .github/ISSUE_TEMPLATE/config.yml | 10 ++++++ .github/ISSUE_TEMPLATE/replay-bug.yml | 45 +++++++++++++++++++++++++++ 2 files changed, 55 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/replay-bug.yml diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..db7baf6f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,10 @@ +# Allow issues to be created without a template +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! + url: mailto:security@webrecorder.org + - 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/replay-bug.yml b/.github/ISSUE_TEMPLATE/replay-bug.yml new file mode 100644 index 00000000..c9a7676e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/replay-bug.yml @@ -0,0 +1,45 @@ +name: Replay Bug Report +description: If archived content isn't displaying as expected, please file this type of issue! +title: "[Replay Bug]: " +labels: ["replay bug", "bug"] +body: + # Version number + - type: input + id: version + attributes: + label: ReplayWeb.page Version + description: This can be found in the "About ReplayWeb.page" dialog + placeholder: "v1.8.13" + validations: + required: true + # What did the user expect to happen? What was the actual behavior? + - type: textarea + attributes: + label: What did you expect to happen? What happened instead? + description: | + "On the live site, the element displays properly on hover. When replayed..." + + Please submit any screenshots/videos that can be used to understand how to reproduce the issue. You can attach images by clicking this area to highlight it and then dragging files into the browser window. + + Please include a link to any relevant archived items if possible. + validations: + required: true + # Step-by-step reproduction instructions + - type: textarea + attributes: + label: Step-by-step reproduction instructions + description: | + Please include step-by-step instructions for how to reproduce the issue if it is not immediately visible or already made clear in the above section. + placeholder: | + 1. Navigate to... + 2. Click on... + 3. See error... + validations: + required: false + # Additional details + - type: textarea + attributes: + label: Additional details + description: Add any other relevant information here. + validations: + required: false From 201ddd28ea158dae5e57a7279d57b661d22aeea3 Mon Sep 17 00:00:00 2001 From: Henry Wilkinson Date: Tue, 21 Nov 2023 22:02:09 -0500 Subject: [PATCH 2/3] Adds application bug report form --- .github/ISSUE_TEMPLATE/application-bug.yml | 41 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/replay-bug.yml | 4 +-- 2 files changed, 43 insertions(+), 2 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/application-bug.yml diff --git a/.github/ISSUE_TEMPLATE/application-bug.yml b/.github/ISSUE_TEMPLATE/application-bug.yml new file mode 100644 index 00000000..f5e6969d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/application-bug.yml @@ -0,0 +1,41 @@ +name: Application Bug Report +description: "If a feature of ReplayWeb.page isn't working as expected and you're sure your issue is reproducible, please file this type of issue!" +title: "[Bug]: " +labels: ["bug"] +body: + # Version number + - type: input + id: version + attributes: + label: ReplayWeb.page Version + description: "This can be found in the "About ReplayWeb.page" dialog" + placeholder: "v1.8.13" + validations: + required: true +# What did the user expect to happen? What was the actual behavior? + - type: textarea + attributes: + label: What did you expect to happen? What happened instead? + description: | + "I was trying to search for content in a loaded archived item, however..." + + Please submit any screenshots/videos that can be used to understand how to reproduce the issue. You can attach images by clicking this area to highlight it and then dragging files into the browser window. + validations: + required: true + # Step-by-step reproduction instructions + - type: textarea + attributes: + label: Step-by-step reproduction instructions + placeholder: | + 1. Navigate to... + 2. Click on... + 3. See error... + validations: + required: true + # Additional details + - type: textarea + attributes: + label: Additional details + description: Add any other relevant information here. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/replay-bug.yml b/.github/ISSUE_TEMPLATE/replay-bug.yml index c9a7676e..5b8aafc9 100644 --- a/.github/ISSUE_TEMPLATE/replay-bug.yml +++ b/.github/ISSUE_TEMPLATE/replay-bug.yml @@ -1,5 +1,5 @@ name: Replay Bug Report -description: If archived content isn't displaying as expected, please file this type of issue! +description: "If archived content isn't displaying as expected, please file this type of issue!" title: "[Replay Bug]: " labels: ["replay bug", "bug"] body: @@ -8,7 +8,7 @@ body: id: version attributes: label: ReplayWeb.page Version - description: This can be found in the "About ReplayWeb.page" dialog + description: "This can be found in the "About ReplayWeb.page" dialog" placeholder: "v1.8.13" validations: required: true From 9b062b2a48d791ad813f931d4d4ac0071c0fcea5 Mon Sep 17 00:00:00 2001 From: Henry Wilkinson Date: Tue, 21 Nov 2023 22:04:31 -0500 Subject: [PATCH 3/3] Adds our feature / change request from --- .github/ISSUE_TEMPLATE/feature-change.yml | 49 +++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/feature-change.yml diff --git a/.github/ISSUE_TEMPLATE/feature-change.yml b/.github/ISSUE_TEMPLATE/feature-change.yml new file mode 100644 index 00000000..64f1e733 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-change.yml @@ -0,0 +1,49 @@ +name: Feature / Change Request +description: "If new things should be added or something that is working as intended should be changed, please file this type of issue!" +title: "[Feature]: " +labels: ["enhancement"] +body: + # Context + - type: textarea + attributes: + label: Context + description: "Describe any prior information that we are taking into account to inform this future development." + placeholder: "Now that x is done we should do y to accomplish z." + validations: + required: true + # User story sentence + - type: textarea + attributes: + 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 + # Requirements + - type: textarea + attributes: + label: Requirements + 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: false + # Todo + - type: textarea + attributes: + label: Todo + 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: + - [ ] UI: + - [ ] API: + validations: + required: false