-
-
Notifications
You must be signed in to change notification settings - Fork 28
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update issue reporting templates #1596
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I liked the old context field before the user story sentence for internal use, but this makes a lot more sense for external folks filing issues. 👍 |
||
description: Any background information that helps us understand the request. | ||
validations: | ||
required: false | ||
required: true |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice! Good to mention this.