580282baa1
- Improve CONTRIBUTING.md with detailed setup instructions and ALwrity-specific guidelines - Enhance SUPPORT.md with comprehensive troubleshooting for AI services and GSC integration - Update SECURITY.md with ALwrity-specific security features and considerations - Add issue template configuration and question form for better issue management - Enhance PR template with ALwrity-specific checklist items - Add comprehensive .github/README.md explaining all community health files These improvements provide better contributor experience and project visibility.
100 lines
3.0 KiB
Markdown
100 lines
3.0 KiB
Markdown
# Pull Request
|
|
|
|
## 📝 Description
|
|
Brief description of changes made in this PR.
|
|
|
|
## 🔄 Type of Change
|
|
- [ ] 🐛 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 not work as expected)
|
|
- [ ] 📚 Documentation update
|
|
- [ ] 🎨 Style/UI changes
|
|
- [ ] ♻️ Code refactoring
|
|
- [ ] ⚡ Performance improvements
|
|
- [ ] 🧪 Test additions/updates
|
|
|
|
## 🎯 Related Issues
|
|
Closes #(issue number)
|
|
Fixes #(issue number)
|
|
Related to #(issue number)
|
|
|
|
## 🧪 Testing
|
|
- [ ] Backend tests pass
|
|
- [ ] Frontend tests pass
|
|
- [ ] Manual testing completed
|
|
- [ ] Cross-browser testing (if applicable)
|
|
- [ ] Mobile testing (if applicable)
|
|
|
|
## 📸 Screenshots (if applicable)
|
|
Add screenshots to help explain your changes.
|
|
|
|
### Before
|
|
<!-- Add before screenshots here -->
|
|
|
|
### After
|
|
<!-- Add after screenshots here -->
|
|
|
|
## 🏷️ Component/Feature
|
|
Which component or feature is affected?
|
|
- [ ] Blog Writer
|
|
- [ ] SEO Dashboard
|
|
- [ ] Content Planning
|
|
- [ ] Facebook Writer
|
|
- [ ] LinkedIn Writer
|
|
- [ ] Onboarding
|
|
- [ ] Authentication
|
|
- [ ] API
|
|
- [ ] Database
|
|
- [ ] GSC Integration
|
|
- [ ] Subscription System
|
|
- [ ] Monitoring/Billing
|
|
- [ ] Documentation
|
|
- [ ] Other: _______________
|
|
|
|
## 📋 Checklist
|
|
- [ ] My code follows the project's style guidelines
|
|
- [ ] I have performed a self-review of my own code
|
|
- [ ] I have commented my code, particularly in hard-to-understand areas
|
|
- [ ] I have made corresponding changes to the documentation
|
|
- [ ] My changes generate no new warnings
|
|
- [ ] I have added tests that prove my fix is effective or that my feature works
|
|
- [ ] New and existing unit tests pass locally with my changes
|
|
- [ ] Any dependent changes have been merged and published
|
|
|
|
### ALwrity-Specific Checklist
|
|
- [ ] API endpoints follow RESTful conventions
|
|
- [ ] AI service integrations handle rate limits and errors gracefully
|
|
- [ ] Content generation includes proper validation and sanitization
|
|
- [ ] Database migrations are included if schema changes are made
|
|
- [ ] Environment variables are documented in env_template.txt
|
|
- [ ] Security considerations have been addressed
|
|
- [ ] Performance impact has been considered
|
|
- [ ] User experience is consistent with existing features
|
|
|
|
## 🔍 Code Quality
|
|
- [ ] Code is properly formatted
|
|
- [ ] No console.log statements left in production code
|
|
- [ ] Error handling is implemented where needed
|
|
- [ ] Performance considerations have been addressed
|
|
- [ ] Security considerations have been addressed
|
|
|
|
## 📚 Documentation
|
|
- [ ] README updated (if needed)
|
|
- [ ] API documentation updated (if needed)
|
|
- [ ] Code comments added for complex logic
|
|
- [ ] Changelog updated (if applicable)
|
|
|
|
## 🚀 Deployment Notes
|
|
Any special deployment considerations or environment variables needed.
|
|
|
|
## 🔗 Additional Context
|
|
Add any other context about the pull request here.
|
|
|
|
## 👥 Reviewers
|
|
Tag specific reviewers if needed:
|
|
@AJaySi @uniqueumesh @DikshaDisciplines
|
|
|
|
---
|
|
|
|
**Thank you for contributing to ALwrity!** 🎉
|