diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index 50cc5d1fce..169a6fb7bc 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -1,5 +1,5 @@ name: Bug Report -description: If something isn't working as expected and you're sure your issue is reproducible, please file this type of issue! +description: Report a demonstrable problem caused by code in this repo. title: "[Bug]: " labels: ["bug"] body: @@ -8,7 +8,7 @@ body: id: version attributes: label: Browsertrix Version - description: This can be found in the site footer + description: This can be found in the bottom end of the Browsertrix web app. placeholder: "v1.5.0-beta.0-67d0c6a" validations: required: true @@ -17,27 +17,38 @@ body: attributes: label: What did you expect to happen? What happened instead? description: | - "I was trying to modify the Page Load Timeout value in a saved workflow, 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. + A clear and concise description of the bug, and what you expected to happen instead. - If your problem is related to crawling, or something wasn't captured in the way you expect please include a link to the finished crawl/workflow if possible. + For issues related to crawling or replay, please include a link to the archived item and workflow when possible. validations: required: true # Step-by-step reproduction instructions - type: textarea attributes: - label: Step-by-step reproduction instructions + label: Reproduction instructions + description: Step-by-step description of how to reproduce the issue, including the page URL if applicable. placeholder: | 1. Navigate to... 2. Click on... 3. See error... validations: required: true + # Screenshots / videos + - type: textarea + attributes: + label: Screenshots / Video + description: Please attach any screenshots or screen recordings that demonstrate the bug. You can attach images by clicking this area to highlight it and then dragging files into the browser window. + # Environment + - type: input + attributes: + label: Environment + description: Please specify your browser if the issue is related to the web app, and provide information on your operating system if you're running Browsertrix locally. + placeholder: | + Browser: + Browser version: + OS: # Additional details - type: textarea attributes: label: Additional details - description: Add any other relevant information here, such as your local environment if you are running Browsertrix locally. - validations: - required: false + description: Any additional context that helps us investigate the issue. For example, does the issue only happen in a specific browser? Are there forum discussions related to your issue? etc. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 4eda5b88ba..f96130dd16 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -3,14 +3,14 @@ blank_issues_enabled: true contact_links: - name: Report a replay issue - about: Issues related to archived content not displaying properly should be reported in the ReplayWeb.page repo. + about: Issues related to an archived item or collection not replaying properly should be reported in the ReplayWeb.page repo. url: https://github.com/webrecorder/replayweb.page/issues/new?&labels=replay+bug%2Cbug&projects=&template=replay-bug.yml&title=[Replay+Bug]%3A+ - 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! + about: Please email security@webrecorder.org directly. We will follow up with you there! url: https://webrecorder.net/.well-known/security.txt - 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! - name: Check out the docs url: https://docs.browsertrix.cloud - about: Solutions to common questions may be available in the documentation! + about: Find solutions to common questions, such as how to install, develop, and deploy Browsertrix. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature-change.yml b/.github/ISSUE_TEMPLATE/feature-change.yml index 2f171ebab3..8ce9df44fa 100644 --- a/.github/ISSUE_TEMPLATE/feature-change.yml +++ b/.github/ISSUE_TEMPLATE/feature-change.yml @@ -1,49 +1,20 @@ 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! +description: Request a new feature or change to an existing feature of the app. 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 ____" + description: Describe the improvement or feature you'd like added to Browsertrix. + placeholder: I would like 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 + # Context - 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: + label: Context + description: Any background information that helps us understand the request. validations: - required: false + required: true \ No newline at end of file