mirror of
				https://github.com/kyantech/Palmr.git
				synced 2025-11-03 21:43:20 +00:00 
			
		
		
		
	chore: add pull request template for improved contribution guidelines
- Introduced a new pull request template to standardize submissions and enhance clarity for contributors. - The template includes sections for description, related issues, motivation, AI usage, testing, and a checklist to ensure quality and completeness. - Aims to streamline the review process and improve collaboration within the project.
This commit is contained in:
		
							
								
								
									
										56
									
								
								.github/pull_request_template.md
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										56
									
								
								.github/pull_request_template.md
									
									
									
									
										vendored
									
									
										Normal file
									
								
							@@ -0,0 +1,56 @@
 | 
				
			|||||||
 | 
					## **🎯 Please make sure you are opening this Pull Request against the `next` branch!**
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## 📝 Description
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Please provide a clear and concise description of the changes introduced by this pull request.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## 🔗 Related Issue(s)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					If this PR fixes or relates to an issue, please link it here (e.g., `Closes #123`).
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## 💡 Motivation and Context
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Why is this change required? What problem does it solve?
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## 🤖 Use of Artificial Intelligence (AI)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					The use of AI tools is absolutely welcome and not an issue. For transparency and continuous improvement, please answer the following:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- Did you use any AI tools (such as GitHub Copilot, ChatGPT, etc.) to help develop this PR?
 | 
				
			||||||
 | 
					    - [ ] No, this PR was developed without the assistance of AI tools.
 | 
				
			||||||
 | 
					    - [ ] Yes, AI tools assisted in the development of this PR (please specify which ones and how they were used):
 | 
				
			||||||
 | 
					        - Tool(s) used:
 | 
				
			||||||
 | 
					        - Brief description of how AI contributed:
 | 
				
			||||||
 | 
					- Was this PR generated entirely by an AI tool (i.e., with minimal human intervention)?  
 | 
				
			||||||
 | 
					    - [ ] No  
 | 
				
			||||||
 | 
					    - [ ] Yes (please provide details):
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## 🧪 How Has This Been Tested?
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Please describe the tests that you ran to verify your changes. Include details about your test environment, and the test cases you ran.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## 📸 Screenshots (if appropriate)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Add any relevant screenshots to help explain your changes.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## 🔄 Types of Changes
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Check the relevant option(s) below:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- [ ] 🐛 Bug fix (non-breaking change which fixes an issue)
 | 
				
			||||||
 | 
					- [ ] ✨ New feature (non-breaking change which adds functionality)
 | 
				
			||||||
 | 
					- [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to change)
 | 
				
			||||||
 | 
					- [ ] 📚 Documentation update
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## ✅ Checklist
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- [ ] My code follows the code style of this project
 | 
				
			||||||
 | 
					- [ ] I have performed a self-review of my code
 | 
				
			||||||
 | 
					- [ ] I have commented my code, particularly in hard-to-understand areas
 | 
				
			||||||
 | 
					- [ ] I have added tests that prove my fix is effective or that my feature works
 | 
				
			||||||
 | 
					- [ ] I have added necessary documentation (if appropriate)
 | 
				
			||||||
 | 
					- [ ] I have rebased and/or merged on top of the latest `next` branch
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					---
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					🙏 Thank you for your contribution!
 | 
				
			||||||
		Reference in New Issue
	
	Block a user