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.
62 lines
2.4 KiB
Markdown
62 lines
2.4 KiB
Markdown
# 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 ALwrity
|
|
- **`CODE_OF_CONDUCT.md`** - Community standards and behavior expectations
|
|
- **`SECURITY.md`** - Security policy and vulnerability reporting
|
|
- **`SUPPORT.md`** - Help resources and troubleshooting guides
|
|
- **`FUNDING.yml`** - Funding and sponsorship information
|
|
|
|
### Issue Templates (`ISSUE_TEMPLATE/`)
|
|
- **`bug_report.md`** - Template for reporting bugs
|
|
- **`feature_request.md`** - Template for requesting new features
|
|
- **`question.yml`** - Form for asking questions
|
|
- **`config.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](https://github.com/AJaySi/ALwrity/issues)
|
|
- Start a [discussion](https://github.com/AJaySi/ALwrity/discussions)
|
|
- Check the [main README](../README.md) for project overview
|
|
|
|
---
|
|
|
|
**Thank you for contributing to ALwrity!** 🚀
|