gh: Update issue templates (#2621)
- Adds issue type to each template - Differentiates user-submitted "Change Request" from internal "Planned Feature". This allows us to separate user-submitted ideas from work we've planned through the new feature workflow, and automatically set the github project. - Adds template for docs change - Makes additional context section optional, I noticed many issues put "n/a" or similar in this section anyway. - Disables blank issue adds generic "Task" issue template
This commit is contained in:
		
							parent
							
								
									7c32e27f94
								
							
						
					
					
						commit
						7e3e8a594f
					
				| @ -2,6 +2,7 @@ name: Bug Report | ||||
| description: Report a demonstrable problem caused by code in this repo. | ||||
| title: "[Bug]: " | ||||
| labels: ["bug"] | ||||
| type: "Bug" | ||||
| body: | ||||
|   # Version number | ||||
|   - type: input | ||||
							
								
								
									
										34
									
								
								.github/ISSUE_TEMPLATE/2-feature-change.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										34
									
								
								.github/ISSUE_TEMPLATE/2-feature-change.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @ -0,0 +1,34 @@ | ||||
| name: Change Request | ||||
| description: Request new functionality or changes to an existing feature. | ||||
| title: "[Change]: " | ||||
| labels: ["enhancement", "idea"] | ||||
| type: "Feature" | ||||
| body: | ||||
|   # Deployment type | ||||
|   - type: dropdown | ||||
|     id: deployment | ||||
|     attributes: | ||||
|       label: Browsertrix Host | ||||
|       description: Are you self-hosting Browsertrix, or are you on a hosted plan? | ||||
|       options: | ||||
|         - Self-Hosted | ||||
|         - Hosted by Webrecorder | ||||
|     validations: | ||||
|       required: true | ||||
|   - type: textarea | ||||
|     attributes: | ||||
|       label: What change would you like to see? | ||||
|       description: | | ||||
|         A clear and concise description of the change to existing functionality. | ||||
| 
 | ||||
|         For general ideas on how to improve Browsertrix, or if you have questions about  | ||||
|         existing functionality, please check our [community forum](https://forum.webrecorder.net/)  | ||||
|         before submitting a request. | ||||
|       placeholder: I would like to be able to ____________ so that I can ____________. | ||||
|     validations: | ||||
|       required: true | ||||
|   # Additional details | ||||
|   - type: textarea | ||||
|     attributes: | ||||
|       label: Additional details | ||||
|       description: Any additional context that helps us understand this request. | ||||
| @ -2,6 +2,7 @@ name: Localization Request | ||||
| description: Request a new language or translation. | ||||
| title: "[L10N]: " | ||||
| labels: ["localization"] | ||||
| type: "Task" | ||||
| body: | ||||
|   - type: textarea | ||||
|     attributes: | ||||
| @ -12,6 +13,4 @@ body: | ||||
|   - type: textarea | ||||
|     attributes: | ||||
|       label: Context | ||||
|       description: Any background information that helps us understand the request. | ||||
|     validations: | ||||
|       required: true | ||||
|       description: Any background information that helps us understand the request. | ||||
							
								
								
									
										16
									
								
								.github/ISSUE_TEMPLATE/4-docs-change.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										16
									
								
								.github/ISSUE_TEMPLATE/4-docs-change.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @ -0,0 +1,16 @@ | ||||
| name: Documentation / User Guide Change | ||||
| description: Request an update to https://docs.browsertrix.com. | ||||
| title: "[Docs]: " | ||||
| labels: ["documentation"] | ||||
| type: "Task" | ||||
| body: | ||||
|   - type: textarea | ||||
|     attributes: | ||||
|       label: Description | ||||
|       description: A summary of the change. | ||||
|     validations: | ||||
|       required: true | ||||
|   - type: textarea | ||||
|     attributes: | ||||
|       label: Context | ||||
|       description: Additional context. | ||||
							
								
								
									
										23
									
								
								.github/ISSUE_TEMPLATE/5-new-feature.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										23
									
								
								.github/ISSUE_TEMPLATE/5-new-feature.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @ -0,0 +1,23 @@ | ||||
| name: (Webrecorder Team) Planned Feature | ||||
| description: For internal Webrecorder use only. | ||||
| title: "[Feature]: " | ||||
| labels: ["feature design", "ui/ux", "front end", "back end"] | ||||
| type: "Feature" | ||||
| projects: ["webrecorder/9"] | ||||
| body: | ||||
|   - type: textarea | ||||
|     attributes: | ||||
|       label: Description | ||||
|       description: A summary of the new or improved feature. | ||||
|     validations: | ||||
|       required: true | ||||
|   - type: textarea | ||||
|     attributes: | ||||
|       label: Requirements | ||||
|       description: A list of software requirements. | ||||
|     validations: | ||||
|       required: true | ||||
|   - type: textarea | ||||
|     attributes: | ||||
|       label: Context | ||||
|       description: Additional context. | ||||
							
								
								
									
										16
									
								
								.github/ISSUE_TEMPLATE/6-task.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										16
									
								
								.github/ISSUE_TEMPLATE/6-task.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @ -0,0 +1,16 @@ | ||||
| name: (Webrecorder Team) Task | ||||
| description: For internal Webrecorder use only. | ||||
| title: "[Task]: " | ||||
| type: "Task" | ||||
| projects: ["webrecorder/9"] | ||||
| body: | ||||
|   - type: textarea | ||||
|     attributes: | ||||
|       label: Description | ||||
|       description: A summary of the task. | ||||
|     validations: | ||||
|       required: true | ||||
|   - type: textarea | ||||
|     attributes: | ||||
|       label: Context | ||||
|       description: Additional context. | ||||
							
								
								
									
										3
									
								
								.github/ISSUE_TEMPLATE/config.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										3
									
								
								.github/ISSUE_TEMPLATE/config.yml
									
									
									
									
										vendored
									
									
								
							| @ -1,5 +1,4 @@ | ||||
| # Allow issues to be created without a template | ||||
| blank_issues_enabled: true | ||||
| blank_issues_enabled: false | ||||
| 
 | ||||
| contact_links: | ||||
|   - name: Report a replay issue | ||||
|  | ||||
							
								
								
									
										20
									
								
								.github/ISSUE_TEMPLATE/feature-change.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										20
									
								
								.github/ISSUE_TEMPLATE/feature-change.yml
									
									
									
									
										vendored
									
									
								
							| @ -1,20 +0,0 @@ | ||||
| name: Feature / Change Request | ||||
| description: Request a new feature or change to an existing feature of the app. | ||||
| title: "[Feature]: " | ||||
| labels: ["enhancement"] | ||||
| body: | ||||
|   # User story sentence | ||||
|   - type: textarea | ||||
|     attributes: | ||||
|       label: What change would you like to see? | ||||
|       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 | ||||
|   # Context | ||||
|   - type: textarea | ||||
|     attributes: | ||||
|       label: Context | ||||
|       description: Any background information that helps us understand the request. | ||||
|     validations: | ||||
|       required: true | ||||
		Loading…
	
		Reference in New Issue
	
	Block a user