mirror of
				https://github.com/meilisearch/meilisearch.git
				synced 2025-11-04 09:56:28 +00:00 
			
		
		
		
	Update issue templates (#1564)
This commit is contained in:
		
				
					committed by
					
						
						GitHub
					
				
			
			
				
	
			
			
			
						parent
						
							5c9401ad94
						
					
				
				
					commit
					418be3daa8
				
			
							
								
								
									
										14
									
								
								.github/ISSUE_TEMPLATE/bug_report.md
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										14
									
								
								.github/ISSUE_TEMPLATE/bug_report.md
									
									
									
									
										vendored
									
									
								
							@@ -23,16 +23,8 @@ A clear and concise description of what you expected to happen.
 | 
				
			|||||||
**Screenshots**
 | 
					**Screenshots**
 | 
				
			||||||
If applicable, add screenshots to help explain your problem.
 | 
					If applicable, add screenshots to help explain your problem.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
**Desktop (please complete the following information):**
 | 
					**MeiliSearch version:** [e.g. v0.20.0]
 | 
				
			||||||
 - OS: [e.g. iOS]
 | 
					 | 
				
			||||||
 - Browser [e.g. chrome, safari]
 | 
					 | 
				
			||||||
 - Version [e.g. 22]
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
**Smartphone (please complete the following information):**
 | 
					 | 
				
			||||||
 - Device: [e.g. iPhone6]
 | 
					 | 
				
			||||||
 - OS: [e.g. iOS8.1]
 | 
					 | 
				
			||||||
 - Browser [e.g. stock browser, safari]
 | 
					 | 
				
			||||||
 - Version [e.g. 22]
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
**Additional context**
 | 
					**Additional context**
 | 
				
			||||||
Add any other context about the problem here.
 | 
					Additional information that may be relevant to the issue.
 | 
				
			||||||
 | 
					[e.g. architecture, device, OS, browser]
 | 
				
			||||||
							
								
								
									
										10
									
								
								.github/ISSUE_TEMPLATE/config.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										10
									
								
								.github/ISSUE_TEMPLATE/config.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							@@ -0,0 +1,10 @@
 | 
				
			|||||||
 | 
					contact_links:
 | 
				
			||||||
 | 
					  - name: Feature request
 | 
				
			||||||
 | 
					    url: https://github.com/meilisearch/product/discussions/new
 | 
				
			||||||
 | 
					    about: For feature requests, please open a discussion in our dedicated product repository
 | 
				
			||||||
 | 
					  - name: Documentation issue
 | 
				
			||||||
 | 
					    url: https://github.com/meilisearch/documentation/issues/new
 | 
				
			||||||
 | 
					    about: For documentation issues, open an issue or a PR in the documentation repository
 | 
				
			||||||
 | 
					  - name: Support questions & other
 | 
				
			||||||
 | 
					    url: https://github.com/meilisearch/MeiliSearch/discussions/new
 | 
				
			||||||
 | 
					    about: For any other question, open a discussion in this repository
 | 
				
			||||||
							
								
								
									
										20
									
								
								.github/ISSUE_TEMPLATE/feature_request.md
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										20
									
								
								.github/ISSUE_TEMPLATE/feature_request.md
									
									
									
									
										vendored
									
									
								
							@@ -1,20 +0,0 @@
 | 
				
			|||||||
---
 | 
					 | 
				
			||||||
name: Feature request
 | 
					 | 
				
			||||||
about: Suggest an idea for this project
 | 
					 | 
				
			||||||
title: ''
 | 
					 | 
				
			||||||
labels: ''
 | 
					 | 
				
			||||||
assignees: ''
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
---
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
**Is your feature request related to a problem? Please describe.**
 | 
					 | 
				
			||||||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
**Describe the solution you'd like**
 | 
					 | 
				
			||||||
A clear and concise description of what you want to happen.
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
**Describe alternatives you've considered**
 | 
					 | 
				
			||||||
A clear and concise description of any alternative solutions or features you've considered.
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
**Additional context**
 | 
					 | 
				
			||||||
Add any other context or screenshots about the feature request here.
 | 
					 | 
				
			||||||
							
								
								
									
										40
									
								
								.github/ISSUE_TEMPLATE/tracking-issue.md
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										40
									
								
								.github/ISSUE_TEMPLATE/tracking-issue.md
									
									
									
									
										vendored
									
									
								
							@@ -1,40 +0,0 @@
 | 
				
			|||||||
---
 | 
					 | 
				
			||||||
name: Tracking issue
 | 
					 | 
				
			||||||
about: Template for a tracking issue
 | 
					 | 
				
			||||||
title: ''
 | 
					 | 
				
			||||||
labels: tracking-issue
 | 
					 | 
				
			||||||
assignees: ''
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
---
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
# Summary
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
One paragraph to explain the feature.
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
# Motivations
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
Why are we doing this? What use cases does it support? What is the expected outcome?
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
# Explanation
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
Explain the proposal like it was the final documentation of this proposal.
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- What is changing for end-users.
 | 
					 | 
				
			||||||
- How it works.
 | 
					 | 
				
			||||||
- What is breaking?
 | 
					 | 
				
			||||||
- Examples.
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
# Implementation
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
Explain the technical specificities that will need to be known or done in order to implement this proposal.
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
## Steps
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
Describe each step to create the feature with it's associated issue/PR.
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
# Related
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- [ ] Validated by the team (@people needed)
 | 
					 | 
				
			||||||
- [ ] Test added
 | 
					 | 
				
			||||||
- [ ] [Documentation](https://github.com/meilisearch/documentation/issues/#xxx) //Change xxx or remove the line
 | 
					 | 
				
			||||||
- [ ] [SDK/Integrations](https://github.com/meilisearch/integration-guides/issues/#xxx) //Change xxx or remove the line
 | 
					 | 
				
			||||||
		Reference in New Issue
	
	Block a user