Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update issue reporting templates (#1596)
Changes: - Edits templates for succinctness and precision - Separate section for screenshots and OS/browser for bugs - Removes requirements and TODO section of features to simplify interface for external-facing requests
- Loading branch information
Showing
3 changed files
with
31 additions
and
49 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |