Improve the bug report templates (#25621)
This commit is contained in:
		
							parent
							
								
									58b52b7a33
								
							
						
					
					
						commit
						eeff7c14e5
					
				
					 4 changed files with 141 additions and 56 deletions
				
			
		
							
								
								
									
										56
									
								
								.github/ISSUE_TEMPLATE/1.bug_report.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										56
									
								
								.github/ISSUE_TEMPLATE/1.bug_report.yml
									
									
									
									
										vendored
									
									
								
							| 
						 | 
					@ -1,56 +0,0 @@
 | 
				
			||||||
name: Bug Report
 | 
					 | 
				
			||||||
description: If something isn't working as expected
 | 
					 | 
				
			||||||
labels: [bug]
 | 
					 | 
				
			||||||
body:
 | 
					 | 
				
			||||||
  - type: markdown
 | 
					 | 
				
			||||||
    attributes:
 | 
					 | 
				
			||||||
      value: |
 | 
					 | 
				
			||||||
        Make sure that you are submitting a new bug that was not previously reported or already fixed.
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
        Please use a concise and distinct title for the issue.
 | 
					 | 
				
			||||||
  - type: textarea
 | 
					 | 
				
			||||||
    attributes:
 | 
					 | 
				
			||||||
      label: Steps to reproduce the problem
 | 
					 | 
				
			||||||
      description: What were you trying to do?
 | 
					 | 
				
			||||||
      value: |
 | 
					 | 
				
			||||||
        1.
 | 
					 | 
				
			||||||
        2.
 | 
					 | 
				
			||||||
        3.
 | 
					 | 
				
			||||||
        ...
 | 
					 | 
				
			||||||
    validations:
 | 
					 | 
				
			||||||
      required: true
 | 
					 | 
				
			||||||
  - type: input
 | 
					 | 
				
			||||||
    attributes:
 | 
					 | 
				
			||||||
      label: Expected behaviour
 | 
					 | 
				
			||||||
      description: What should have happened?
 | 
					 | 
				
			||||||
    validations:
 | 
					 | 
				
			||||||
      required: true
 | 
					 | 
				
			||||||
  - type: input
 | 
					 | 
				
			||||||
    attributes:
 | 
					 | 
				
			||||||
      label: Actual behaviour
 | 
					 | 
				
			||||||
      description: What happened?
 | 
					 | 
				
			||||||
    validations:
 | 
					 | 
				
			||||||
      required: true
 | 
					 | 
				
			||||||
  - type: textarea
 | 
					 | 
				
			||||||
    attributes:
 | 
					 | 
				
			||||||
      label: Detailed description
 | 
					 | 
				
			||||||
    validations:
 | 
					 | 
				
			||||||
      required: false
 | 
					 | 
				
			||||||
  - type: textarea
 | 
					 | 
				
			||||||
    attributes:
 | 
					 | 
				
			||||||
      label: Specifications
 | 
					 | 
				
			||||||
      description: |
 | 
					 | 
				
			||||||
        What version or commit hash of Mastodon did you find this bug in?
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
        If a front-end issue, what browser and operating systems were you using?
 | 
					 | 
				
			||||||
      placeholder: |
 | 
					 | 
				
			||||||
        Mastodon 3.5.3 (or Edge)
 | 
					 | 
				
			||||||
        Ruby 2.7.6 (or v3.1.2)
 | 
					 | 
				
			||||||
        Node.js 16.18.0
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
        Google Chrome 106.0.5249.119
 | 
					 | 
				
			||||||
        Firefox 105.0.3
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
        etc...
 | 
					 | 
				
			||||||
    validations:
 | 
					 | 
				
			||||||
      required: true
 | 
					 | 
				
			||||||
							
								
								
									
										76
									
								
								.github/ISSUE_TEMPLATE/1.web_bug_report.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										76
									
								
								.github/ISSUE_TEMPLATE/1.web_bug_report.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| 
						 | 
					@ -0,0 +1,76 @@
 | 
				
			||||||
 | 
					name: Bug Report (Web Interface)
 | 
				
			||||||
 | 
					description: If you are using Mastodon's web interface and something is not working as expected
 | 
				
			||||||
 | 
					labels: [bug, 'status/to triage', 'area/web interface']
 | 
				
			||||||
 | 
					body:
 | 
				
			||||||
 | 
					  - type: markdown
 | 
				
			||||||
 | 
					    attributes:
 | 
				
			||||||
 | 
					      value: |
 | 
				
			||||||
 | 
					        Make sure that you are submitting a new bug that was not previously reported or already fixed.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					        Please use a concise and distinct title for the issue.
 | 
				
			||||||
 | 
					  - type: textarea
 | 
				
			||||||
 | 
					    attributes:
 | 
				
			||||||
 | 
					      label: Steps to reproduce the problem
 | 
				
			||||||
 | 
					      description: What were you trying to do?
 | 
				
			||||||
 | 
					      value: |
 | 
				
			||||||
 | 
					        1.
 | 
				
			||||||
 | 
					        2.
 | 
				
			||||||
 | 
					        3.
 | 
				
			||||||
 | 
					        ...
 | 
				
			||||||
 | 
					    validations:
 | 
				
			||||||
 | 
					      required: true
 | 
				
			||||||
 | 
					  - type: input
 | 
				
			||||||
 | 
					    attributes:
 | 
				
			||||||
 | 
					      label: Expected behaviour
 | 
				
			||||||
 | 
					      description: What should have happened?
 | 
				
			||||||
 | 
					    validations:
 | 
				
			||||||
 | 
					      required: true
 | 
				
			||||||
 | 
					  - type: input
 | 
				
			||||||
 | 
					    attributes:
 | 
				
			||||||
 | 
					      label: Actual behaviour
 | 
				
			||||||
 | 
					      description: What happened?
 | 
				
			||||||
 | 
					    validations:
 | 
				
			||||||
 | 
					      required: true
 | 
				
			||||||
 | 
					  - type: textarea
 | 
				
			||||||
 | 
					    attributes:
 | 
				
			||||||
 | 
					      label: Detailed description
 | 
				
			||||||
 | 
					    validations:
 | 
				
			||||||
 | 
					      required: false
 | 
				
			||||||
 | 
					  - type: input
 | 
				
			||||||
 | 
					    attributes:
 | 
				
			||||||
 | 
					      label: Mastodon instance
 | 
				
			||||||
 | 
					      description: The address of the Mastodon instance where you experienced the issue
 | 
				
			||||||
 | 
					      placeholder: mastodon.social
 | 
				
			||||||
 | 
					    validations:
 | 
				
			||||||
 | 
					      required: true
 | 
				
			||||||
 | 
					  - type: input
 | 
				
			||||||
 | 
					    attributes:
 | 
				
			||||||
 | 
					      label: Mastodon version
 | 
				
			||||||
 | 
					      description: |
 | 
				
			||||||
 | 
					        This is displayed at the bottom of the About page, eg. `v4.1.2+nightly-20230627`
 | 
				
			||||||
 | 
					      placeholder: v4.1.2
 | 
				
			||||||
 | 
					    validations:
 | 
				
			||||||
 | 
					      required: true
 | 
				
			||||||
 | 
					  - type: input
 | 
				
			||||||
 | 
					    attributes:
 | 
				
			||||||
 | 
					      label: Browser name and version
 | 
				
			||||||
 | 
					      description: |
 | 
				
			||||||
 | 
					        What browser are you using when getting this bug? Please specify the version as well.
 | 
				
			||||||
 | 
					      placeholder: Firefox 105.0.3
 | 
				
			||||||
 | 
					    validations:
 | 
				
			||||||
 | 
					      required: true
 | 
				
			||||||
 | 
					  - type: input
 | 
				
			||||||
 | 
					    attributes:
 | 
				
			||||||
 | 
					      label: Operating system
 | 
				
			||||||
 | 
					      description: |
 | 
				
			||||||
 | 
					        What OS are you running? Please specify the version as well.
 | 
				
			||||||
 | 
					      placeholder: macOS 13.4.1
 | 
				
			||||||
 | 
					    validations:
 | 
				
			||||||
 | 
					      required: true
 | 
				
			||||||
 | 
					  - type: textarea
 | 
				
			||||||
 | 
					    attributes:
 | 
				
			||||||
 | 
					      label: Technical details
 | 
				
			||||||
 | 
					      description: |
 | 
				
			||||||
 | 
					        Any additional technical details you may have. This can include the full error log, inspector's output…
 | 
				
			||||||
 | 
					    validations:
 | 
				
			||||||
 | 
					      required: false
 | 
				
			||||||
							
								
								
									
										65
									
								
								.github/ISSUE_TEMPLATE/2.server_bug_report.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										65
									
								
								.github/ISSUE_TEMPLATE/2.server_bug_report.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| 
						 | 
					@ -0,0 +1,65 @@
 | 
				
			||||||
 | 
					name: Bug Report (server / API)
 | 
				
			||||||
 | 
					description: |
 | 
				
			||||||
 | 
					  If something is not working as expected, but is not from using the web interface.
 | 
				
			||||||
 | 
					labels: [bug, 'status/to triage']
 | 
				
			||||||
 | 
					body:
 | 
				
			||||||
 | 
					  - type: markdown
 | 
				
			||||||
 | 
					    attributes:
 | 
				
			||||||
 | 
					      value: |
 | 
				
			||||||
 | 
					        Make sure that you are submitting a new bug that was not previously reported or already fixed.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					        Please use a concise and distinct title for the issue.
 | 
				
			||||||
 | 
					  - type: textarea
 | 
				
			||||||
 | 
					    attributes:
 | 
				
			||||||
 | 
					      label: Steps to reproduce the problem
 | 
				
			||||||
 | 
					      description: What were you trying to do?
 | 
				
			||||||
 | 
					      value: |
 | 
				
			||||||
 | 
					        1.
 | 
				
			||||||
 | 
					        2.
 | 
				
			||||||
 | 
					        3.
 | 
				
			||||||
 | 
					        ...
 | 
				
			||||||
 | 
					    validations:
 | 
				
			||||||
 | 
					      required: true
 | 
				
			||||||
 | 
					  - type: input
 | 
				
			||||||
 | 
					    attributes:
 | 
				
			||||||
 | 
					      label: Expected behaviour
 | 
				
			||||||
 | 
					      description: What should have happened?
 | 
				
			||||||
 | 
					    validations:
 | 
				
			||||||
 | 
					      required: true
 | 
				
			||||||
 | 
					  - type: input
 | 
				
			||||||
 | 
					    attributes:
 | 
				
			||||||
 | 
					      label: Actual behaviour
 | 
				
			||||||
 | 
					      description: What happened?
 | 
				
			||||||
 | 
					    validations:
 | 
				
			||||||
 | 
					      required: true
 | 
				
			||||||
 | 
					  - type: textarea
 | 
				
			||||||
 | 
					    attributes:
 | 
				
			||||||
 | 
					      label: Detailed description
 | 
				
			||||||
 | 
					    validations:
 | 
				
			||||||
 | 
					      required: false
 | 
				
			||||||
 | 
					  - type: input
 | 
				
			||||||
 | 
					    attributes:
 | 
				
			||||||
 | 
					      label: Mastodon instance
 | 
				
			||||||
 | 
					      description: The address of the Mastodon instance where you experienced the issue
 | 
				
			||||||
 | 
					      placeholder: mastodon.social
 | 
				
			||||||
 | 
					    validations:
 | 
				
			||||||
 | 
					      required: false
 | 
				
			||||||
 | 
					  - type: input
 | 
				
			||||||
 | 
					    attributes:
 | 
				
			||||||
 | 
					      label: Mastodon version
 | 
				
			||||||
 | 
					      description: |
 | 
				
			||||||
 | 
					        This is displayed at the bottom of the About page, eg. `v4.1.2+nightly-20230627`
 | 
				
			||||||
 | 
					      placeholder: v4.1.2
 | 
				
			||||||
 | 
					    validations:
 | 
				
			||||||
 | 
					      required: false
 | 
				
			||||||
 | 
					  - type: textarea
 | 
				
			||||||
 | 
					    attributes:
 | 
				
			||||||
 | 
					      label: Technical details
 | 
				
			||||||
 | 
					      description: |
 | 
				
			||||||
 | 
					        Any additional technical details you may have, like logs or error traces
 | 
				
			||||||
 | 
					      value: |
 | 
				
			||||||
 | 
					        If this is happening on your own Mastodon server, please fill out those:
 | 
				
			||||||
 | 
					        - Ruby version: (from `ruby --version`, eg. v3.1.2)
 | 
				
			||||||
 | 
					        - Node.js version: (from `node --version`, eg. v18.16.0)
 | 
				
			||||||
 | 
					    validations:
 | 
				
			||||||
 | 
					      required: false
 | 
				
			||||||
		Loading…
	
		Reference in a new issue