system-prompts-and-models-o.../.github/PULL_REQUEST_TEMPLATE.md
Sahiix@1 13254d7cbf feat: Add metadata system, REST API, examples, and CI/CD pipeline
- Added 32 JSON metadata files for all AI coding tools
- Generated 39 REST API endpoints for programmatic access
- Created working examples in Python, JavaScript, and PowerShell
- Set up GitHub Actions workflow for automated deployment
- Enhanced README with comprehensive feature documentation
- Added version comparison and automation tools
- Updated 20+ documentation files
- Ready for GitHub Pages deployment
2025-10-02 22:23:26 +04:00

173 lines
3.7 KiB
Markdown

# Pull Request
## 📝 Description
**What does this PR do?**
[Provide a clear description of the changes]
---
## 🎯 Type of Change
- [ ] 🆕 New tool addition
- [ ] 🔄 Tool update (new version)
- [ ] 📚 Documentation improvement
- [ ] 🐛 Bug fix
- [ ] ✨ Enhancement
- [ ] 🔧 Repository structure change
- [ ] 🎨 Visual/UI improvement
- [ ] Other: ___________
---
## 📂 Files Changed
**Summary of changes:**
- Added: `path/to/new/file`
- Modified: `path/to/existing/file`
- Deleted: `path/to/old/file`
---
## 🔍 For New Tools
**Tool Information:**
- **Name:** [Tool name]
- **Type:** [IDE/CLI/Web/Agent]
- **Version:** [version or date]
- **Source:** [How you obtained the prompt]
**Files included:**
- [ ] Prompt.txt (or versioned prompt files)
- [ ] Tools.json (if applicable)
- [ ] README.md (tool-specific)
- [ ] Updated main README.md
- [ ] Updated COMPARISON.md
---
## ✅ Checklist
**Before submitting:**
- [ ] I've read [CONTRIBUTING.md](../CONTRIBUTING.md)
- [ ] Files follow the repository structure
- [ ] Prompts are properly formatted
- [ ] Source attribution is clear
- [ ] No secrets or credentials included
- [ ] Markdown is properly formatted
- [ ] Links are working
- [ ] I've tested any code changes
**For new tools:**
- [ ] Added tool directory with proper structure
- [ ] Created tool-specific README.md
- [ ] Updated main README.md with tool entry
- [ ] Updated COMPARISON.md with tool details
- [ ] Documented source and extraction method
**For documentation changes:**
- [ ] No typos or grammatical errors
- [ ] Links are valid
- [ ] Information is accurate
- [ ] Consistent with existing style
---
## 🔒 Legal & Ethical Compliance
**I confirm that:**
- [ ] These materials were obtained legally and ethically
- [ ] I have the right to share these materials
- [ ] Source attribution is accurate
- [ ] No proprietary information was obtained through unauthorized means
- [ ] I'm not violating any terms of service
**Extraction method used:**
- [ ] Official documentation
- [ ] Open source repository
- [ ] Public API documentation
- [ ] Community shared (with permission)
- [ ] Ethical reverse engineering
- [ ] Other: ___________
---
## 🧪 Testing
**How have you verified your changes?**
- [ ] Checked for typos/errors
- [ ] Verified all links work
- [ ] Tested prompt with actual API (if applicable)
- [ ] Compared with actual tool behavior
- [ ] Reviewed formatting in preview
- [ ] Ran static site locally (if applicable)
---
## 📸 Screenshots (Optional)
**If visual changes, add screenshots:**
[Paste screenshots here]
---
## 🔗 Related Issues
**Does this close any issues?**
Closes #[issue number]
Fixes #[issue number]
Related to #[issue number]
---
## 📊 Impact
**Who benefits from this change?**
- [ ] All users of the repository
- [ ] Users interested in [specific tool]
- [ ] Researchers
- [ ] Contributors
- [ ] Developers building similar tools
---
## 📚 Additional Context
**Anything else reviewers should know:**
[Add any additional information]
---
## 🤝 Contribution Notes
**First-time contributor?**
- [ ] Yes - This is my first PR to this repository
- [ ] No - I've contributed before
**Need help?**
- [ ] I'm open to feedback and changes
- [ ] I might need help with [specific area]
---
## 📅 Version Information (For Tool Updates)
**If updating an existing tool:**
- **Previous version:** [version/date]
- **New version:** [version/date]
- **What changed:** [Brief summary]
- **Breaking changes:** [Yes/No, details if yes]
---
## 🙏 Thank You!
Thank you for contributing to this repository! Your contribution helps the AI coding community learn and build better tools.
---
**Maintainer Notes (will be filled by reviewers):**
- [ ] Reviewed and approved
- [ ] Requested changes
- [ ] Needs more information