- 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.
2.4 KiB
2.4 KiB
ALwrity Community Health Files
This directory contains community health files that help maintain a welcoming and productive environment for contributors to ALwrity.
📁 Files Overview
Core Community Files
CONTRIBUTING.md- Guidelines for contributing to ALwrityCODE_OF_CONDUCT.md- Community standards and behavior expectationsSECURITY.md- Security policy and vulnerability reportingSUPPORT.md- Help resources and troubleshooting guidesFUNDING.yml- Funding and sponsorship information
Issue Templates (ISSUE_TEMPLATE/)
bug_report.md- Template for reporting bugsfeature_request.md- Template for requesting new featuresquestion.yml- Form for asking questionsconfig.yml- Issue template configuration
Pull Request Template
pull_request_template.md- Template for pull requests
🎯 Purpose
These files help:
- Improve Project Visibility - Better GitHub community profile score
- Enhance Contributor Experience - Clear guidelines and expectations
- Streamline Issue Management - Structured templates for better organization
- Maintain Quality - Consistent PR reviews and code standards
- Build Community - Welcoming environment for all contributors
📊 Community Profile Status
With these files, ALwrity should achieve:
- ✅ README - Comprehensive project documentation
- ✅ Contributing - Clear contribution guidelines
- ✅ Code of Conduct - Community standards
- ✅ License - MIT License (in root directory)
- ✅ Issue Templates - Structured issue reporting
- ✅ Pull Request Template - Consistent PR format
- ✅ Security Policy - Vulnerability reporting process
- ✅ Support - Help resources and documentation
🔄 Maintenance
These files should be updated as the project evolves:
- Review and update contribution guidelines quarterly
- Update security policy when new features are added
- Refresh issue templates based on common questions
- Update support resources as new features are released
📞 Questions?
If you have questions about these community health files:
- Open an issue
- Start a discussion
- Check the main README for project overview
Thank you for contributing to ALwrity! 🚀