mirror of
				https://github.com/matrix-org/synapse.git
				synced 2025-11-03 21:57:26 +00:00 
			
		
		
		
	Add more prompts to bug report form (#14522)
This commit is contained in:
		
							parent
							
								
									6d47b7e325
								
							
						
					
					
						commit
						972743051b
					
				
							
								
								
									
										45
									
								
								.github/ISSUE_TEMPLATE/BUG_REPORT.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										45
									
								
								.github/ISSUE_TEMPLATE/BUG_REPORT.yml
									
									
									
									
										vendored
									
									
								
							@ -74,6 +74,36 @@ body:
 | 
				
			|||||||
        - Debian packages from packages.matrix.org
 | 
					        - Debian packages from packages.matrix.org
 | 
				
			||||||
        - pip (from PyPI)
 | 
					        - pip (from PyPI)
 | 
				
			||||||
        - Other (please mention below)
 | 
					        - Other (please mention below)
 | 
				
			||||||
 | 
					        - I don't know
 | 
				
			||||||
 | 
					    validations:
 | 
				
			||||||
 | 
					      required: true
 | 
				
			||||||
 | 
					  - type: input
 | 
				
			||||||
 | 
					    id: database
 | 
				
			||||||
 | 
					    attributes:
 | 
				
			||||||
 | 
					      label: Database
 | 
				
			||||||
 | 
					      description: |
 | 
				
			||||||
 | 
					        Are you using SQLite or PostgreSQL? What's the version of your database?
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					        If PostgreSQL, please also answer the following:
 | 
				
			||||||
 | 
					         - are you using a single PostgreSQL server
 | 
				
			||||||
 | 
					        or [separate servers for `main` and `state`](https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#databases)?
 | 
				
			||||||
 | 
					         - have you previously ported from SQLite using the Synapse "portdb" script?
 | 
				
			||||||
 | 
					         - have you previously restored from a backup?
 | 
				
			||||||
 | 
					    validations:
 | 
				
			||||||
 | 
					      required: true
 | 
				
			||||||
 | 
					  - type: dropdown
 | 
				
			||||||
 | 
					    id: workers
 | 
				
			||||||
 | 
					    attributes:
 | 
				
			||||||
 | 
					      label: Workers
 | 
				
			||||||
 | 
					      description: |
 | 
				
			||||||
 | 
					        Are you running a single Synapse process, or are you running
 | 
				
			||||||
 | 
					        [2 or more workers](https://matrix-org.github.io/synapse/latest/workers.html)?
 | 
				
			||||||
 | 
					      options:
 | 
				
			||||||
 | 
					        - Single process
 | 
				
			||||||
 | 
					        - Multiple workers
 | 
				
			||||||
 | 
					        - I don't know
 | 
				
			||||||
 | 
					    validations:
 | 
				
			||||||
 | 
					      required: true
 | 
				
			||||||
  - type: textarea
 | 
					  - type: textarea
 | 
				
			||||||
    id: platform
 | 
					    id: platform
 | 
				
			||||||
    attributes:
 | 
					    attributes:
 | 
				
			||||||
@ -83,17 +113,28 @@ body:
 | 
				
			|||||||
        e.g. distro, hardware, if it's running in a vm/container, etc.
 | 
					        e.g. distro, hardware, if it's running in a vm/container, etc.
 | 
				
			||||||
    validations:
 | 
					    validations:
 | 
				
			||||||
      required: true
 | 
					      required: true
 | 
				
			||||||
 | 
					  - type: textarea
 | 
				
			||||||
 | 
					    id: config
 | 
				
			||||||
 | 
					    attributes:
 | 
				
			||||||
 | 
					      label: Configuration
 | 
				
			||||||
 | 
					      description: |
 | 
				
			||||||
 | 
					        Do you have any unusual config options turned on? If so, please provide details.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					        - Experimental or undocumented features
 | 
				
			||||||
 | 
					        - [Presence](https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#presence)
 | 
				
			||||||
 | 
					        - [Message retention](https://matrix-org.github.io/synapse/latest/message_retention_policies.html)
 | 
				
			||||||
 | 
					        - [Synapse modules](https://matrix-org.github.io/synapse/latest/modules/index.html)
 | 
				
			||||||
  - type: textarea
 | 
					  - type: textarea
 | 
				
			||||||
    id: logs
 | 
					    id: logs
 | 
				
			||||||
    attributes:
 | 
					    attributes:
 | 
				
			||||||
      label: Relevant log output
 | 
					      label: Relevant log output
 | 
				
			||||||
      description: |
 | 
					      description: |
 | 
				
			||||||
        Please copy and paste any relevant log output, ideally at INFO or DEBUG log level.
 | 
					        Please copy and paste any relevant log output, ideally at INFO or DEBUG log level.
 | 
				
			||||||
        This will be automatically formatted into code, so there is no need for backticks.
 | 
					        This will be automatically formatted into code, so there is no need for backticks (`\``).
 | 
				
			||||||
 | 
					
 | 
				
			||||||
        Please be careful to remove any personal or private data.
 | 
					        Please be careful to remove any personal or private data.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
        **Bug reports are usually very difficult to diagnose without logging.**
 | 
					        **Bug reports are usually impossible to diagnose without logging.**
 | 
				
			||||||
      render: shell
 | 
					      render: shell
 | 
				
			||||||
    validations:
 | 
					    validations:
 | 
				
			||||||
      required: true
 | 
					      required: true
 | 
				
			||||||
 | 
				
			|||||||
							
								
								
									
										1
									
								
								changelog.d/14522.misc
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										1
									
								
								changelog.d/14522.misc
									
									
									
									
									
										Normal file
									
								
							@ -0,0 +1 @@
 | 
				
			|||||||
 | 
					Add more prompts to the bug report form.
 | 
				
			||||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user