kunthawat/ALwrity
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: Add GitHub community profile files

Browse Source 
- Add CONTRIBUTING.md, CODE_OF_CONDUCT.md, SECURITY.md
- Add issue templates and PR template
- Add SUPPORT.md and FUNDING.yml
- Improve project visibility and contributor experience
This commit is contained in:
ajaysi
2025-09-24 15:47:20 +05:30
parent 8c924b3ee9
commit 6554549494
8 changed files with 688 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

75
.github/CODE_OF_CONDUCT.md vendored Normal file
View File

@@ -0,0 +1,75 @@
# Contributor Covenant Code of Conduct
## Our Pledge
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
## Our Standards
Examples of behavior that contributes to a positive environment for our community include:
* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
Examples of unacceptable behavior include:
* The use of sexualized language or imagery, and sexual attention or advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting
## Enforcement Responsibilities
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
## Scope
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [INSERT CONTACT METHOD]. All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
## Enforcement Guidelines
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
### 1. Correction
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
### 2. Warning
**Community Impact**: A violation through a single incident or series of actions.
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
### 3. Temporary Ban
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
### 4. Permanent Ban
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
**Consequence**: A permanent ban from any sort of public interaction within the community.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
[homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

147
.github/CONTRIBUTING.md vendored Normal file
View File

@@ -0,0 +1,147 @@
# Contributing to ALwrity
Thank you for your interest in contributing to ALwrity! 🚀 We welcome contributions from the community and appreciate your help in making this AI-powered digital marketing platform even better.
## 🤝 How to Contribute
### 1. **Report Issues**
- Use our [GitHub Issues](https://github.com/AJaySi/ALwrity/issues) to report bugs or request features
- Check existing issues before creating new ones
- Provide clear descriptions and steps to reproduce bugs
### 2. **Submit Pull Requests**
- Fork the repository
- Create a feature branch: `git checkout -b feature/amazing-feature`
- Make your changes and test thoroughly
- Submit a pull request with a clear description
### 3. **Code Contributions**
- Follow our coding standards (see below)
- Add tests for new functionality
- Update documentation as needed
- Ensure all tests pass before submitting
## 🛠️ Development Setup
### Prerequisites
- Python 3.10+
- Node.js 18+
- Git
### Backend Setup
```bash
cd backend
pip install -r requirements.txt
python start_alwrity_backend.py
```
### Frontend Setup
```bash
cd frontend
npm install
npm start
```
## 📝 Coding Standards
### Python (Backend)
- Follow PEP 8 style guidelines
- Use type hints where possible
- Add docstrings for functions and classes
- Use meaningful variable and function names
### TypeScript/React (Frontend)
- Use TypeScript for type safety
- Follow React best practices
- Use functional components with hooks
- Implement proper error handling
## 🧪 Testing
### Backend Testing
```bash
cd backend
python -m pytest test/
```
### Frontend Testing
```bash
cd frontend
npm test
```
## 📋 Pull Request Guidelines
### Before Submitting
- [ ] Code follows project style guidelines
- [ ] Self-review completed
- [ ] Tests added/updated and passing
- [ ] Documentation updated
- [ ] No merge conflicts
### PR Description Template
```markdown
## Description
Brief description of changes
## Type of Change
- [ ] Bug fix
- [ ] New feature
- [ ] Breaking change
- [ ] Documentation update
## Testing
- [ ] Backend tests pass
- [ ] Frontend tests pass
- [ ] Manual testing completed
## Screenshots (if applicable)
Add screenshots to help explain your changes
```
## 🏷️ Issue Labels
We use the following labels to categorize issues:
- `bug`: Something isn't working
- `enhancement`: New feature or request
- `documentation`: Improvements or additions to documentation
- `good first issue`: Good for newcomers
- `help wanted`: Extra attention is needed
- `priority: high`: High priority issues
- `priority: low`: Low priority issues
## 💬 Community Guidelines
- Be respectful and inclusive
- Help others learn and grow
- Provide constructive feedback
- Follow the [Code of Conduct](CODE_OF_CONDUCT.md)
## 🎯 Areas for Contribution
### High Priority
- Bug fixes and performance improvements
- Documentation improvements
- Test coverage expansion
- UI/UX enhancements
### Feature Areas
- AI content generation improvements
- SEO analysis enhancements
- Social media integration
- Analytics and reporting
- User experience improvements
## 📞 Getting Help
- Join our [Discussions](https://github.com/AJaySi/ALwrity/discussions)
- Check existing [Issues](https://github.com/AJaySi/ALwrity/issues)
- Review [Documentation](https://github.com/AJaySi/ALwrity/wiki)
## 🙏 Recognition
Contributors will be recognized in our README and release notes. Thank you for helping make ALwrity better for everyone!
---
**Happy Contributing!** 🎉

12
.github/FUNDING.yml vendored Normal file
View File

@@ -0,0 +1,12 @@
# These are supported funding model platforms
github: [AJaySi]
patreon: # Replace with a single Patreon username
open_collective: # Replace with a single Open Collective name
ko_fi: # Replace with a single Ko-fi username
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
liberapay: # Replace with a single Liberapay username
issuehunt: # Replace with a single IssueHunt username
otechie: # Replace with a single Otechie username
custom: ['https://www.alwrity.com/donate', 'https://www.buymeacoffee.com/alwrity']

65
.github/ISSUE_TEMPLATE/bug_report.md vendored Normal file
View File

@@ -0,0 +1,65 @@
---
name: Bug Report
about: Create a report to help us improve ALwrity
title: '[BUG] '
labels: ['bug', 'needs-triage']
assignees: ''
---
## 🐛 Bug Description
A clear and concise description of what the bug is.
## 🔄 Steps to Reproduce
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
## ✅ Expected Behavior
A clear and concise description of what you expected to happen.
## ❌ Actual Behavior
A clear and concise description of what actually happened.
## 📸 Screenshots
If applicable, add screenshots to help explain your problem.
## 🖥️ Environment
**Desktop (please complete the following information):**
- OS: [e.g. Windows 10, macOS 12.0, Ubuntu 20.04]
- Browser: [e.g. Chrome 91, Firefox 89, Safari 14]
- ALwrity Version: [e.g. v1.2.3]
**Mobile (please complete the following information):**
- Device: [e.g. iPhone 12, Samsung Galaxy S21]
- OS: [e.g. iOS 14.6, Android 11]
- Browser: [e.g. Safari, Chrome Mobile]
## 📋 Additional Context
Add any other context about the problem here.
## 🔍 Error Logs
If applicable, paste any error logs or console output here:
```
Paste error logs here
```
## 🏷️ Component/Feature
Which component or feature is affected?
- [ ] Blog Writer
- [ ] SEO Dashboard
- [ ] Content Planning
- [ ] Facebook Writer
- [ ] LinkedIn Writer
- [ ] Onboarding
- [ ] Authentication
- [ ] API
- [ ] Other: _______________
## 🎯 Priority
- [ ] Critical (blocks core functionality)
- [ ] High (major impact on user experience)
- [ ] Medium (minor impact)
- [ ] Low (cosmetic issue)

67
.github/ISSUE_TEMPLATE/feature_request.md vendored Normal file
View File

@@ -0,0 +1,67 @@
---
name: Feature Request
about: Suggest an idea for ALwrity
title: '[FEATURE] '
labels: ['enhancement', 'needs-triage']
assignees: ''
---
## 🚀 Feature Description
A clear and concise description of the feature you'd like to see implemented.
## 💡 Motivation
Why is this feature important? What problem does it solve?
## 📝 Detailed Description
Provide a detailed description of how this feature should work.
## 🎯 Use Cases
Describe specific use cases for this feature:
1. Use case 1
2. Use case 2
3. Use case 3
## 🎨 Mockups/Designs
If applicable, add mockups, wireframes, or design concepts.
## 🔧 Technical Considerations
Any technical considerations or implementation notes:
- [ ] Requires backend changes
- [ ] Requires frontend changes
- [ ] Requires database changes
- [ ] Requires third-party integration
- [ ] Other: _______________
## 🏷️ Component/Feature Area
Which component or feature area does this relate to?
- [ ] Blog Writer
- [ ] SEO Dashboard
- [ ] Content Planning
- [ ] Facebook Writer
- [ ] LinkedIn Writer
- [ ] Onboarding
- [ ] Authentication
- [ ] API
- [ ] UI/UX
- [ ] Performance
- [ ] Other: _______________
## 🎯 Priority
- [ ] Critical (essential for core functionality)
- [ ] High (significant value add)
- [ ] Medium (nice to have)
- [ ] Low (future consideration)
## 🔄 Alternatives Considered
Describe any alternative solutions or features you've considered.
## 📚 Additional Context
Add any other context, research, or references about the feature request here.
## 🤝 Contribution
Are you willing to contribute to implementing this feature?
- [ ] Yes, I can help implement this
- [ ] Yes, I can help with testing
- [ ] Yes, I can help with documentation
- [ ] No, but I can provide feedback
- [ ] No, just suggesting the idea

109
.github/SECURITY.md vendored Normal file
View File

@@ -0,0 +1,109 @@
# Security Policy
## 🔒 Supported Versions
We release patches for security vulnerabilities in the following versions:
| Version | Supported |
| ------- | ------------------ |
| 1.0.x | :white_check_mark: |
| < 1.0 | :x: |
## 🚨 Reporting a Vulnerability
We take security seriously. If you discover a security vulnerability within ALwrity, please follow these steps:
### 1. **DO NOT** create a public GitHub issue
Security vulnerabilities should be reported privately to prevent exploitation.
### 2. **Email us directly**
Send an email to: [security@alwrity.com](mailto:security@alwrity.com)
**Include the following information:**
- Description of the vulnerability
- Steps to reproduce the issue
- Potential impact assessment
- Suggested fix (if any)
- Your contact information
### 3. **Response Timeline**
- **Initial Response**: Within 48 hours
- **Status Update**: Within 7 days
- **Resolution**: Within 30 days (depending on complexity)
### 4. **What to Expect**
- We will acknowledge receipt of your report
- We will investigate and validate the vulnerability
- We will provide regular updates on our progress
- We will coordinate the disclosure timeline with you
- We will credit you in our security advisories (unless you prefer to remain anonymous)
## 🛡️ Security Best Practices
### For Users
- Keep your ALwrity installation updated
- Use strong, unique passwords
- Enable two-factor authentication where available
- Regularly review your API keys and access permissions
- Report suspicious activity immediately
### For Developers
- Follow secure coding practices
- Validate all user inputs
- Use parameterized queries to prevent SQL injection
- Implement proper authentication and authorization
- Keep dependencies updated
- Use HTTPS in production
- Implement rate limiting
- Log security-relevant events
## 🔐 Security Features
ALwrity implements the following security measures:
- **Authentication**: Secure user authentication with JWT tokens
- **Authorization**: Role-based access control
- **Input Validation**: Comprehensive input sanitization
- **API Security**: Rate limiting and request validation
- **Data Encryption**: Sensitive data encryption at rest and in transit
- **CORS Protection**: Proper cross-origin resource sharing configuration
- **Security Headers**: Implementation of security headers
- **Dependency Scanning**: Regular dependency vulnerability scanning
## 🚫 Out of Scope
The following are considered out of scope for our security program:
- Social engineering attacks
- Physical attacks
- Attacks requiring physical access to the server
- Attacks requiring access to the local network
- Denial of service attacks
- Spam or social engineering issues
- Issues in third-party applications or services
## 🏆 Hall of Fame
We maintain a security hall of fame to recognize researchers who help improve ALwrity's security:
- [Your name could be here!]
## 📞 Contact
For security-related questions or concerns:
- **Email**: [security@alwrity.com](mailto:security@alwrity.com)
- **GitHub**: Create a private security advisory
- **Response Time**: 24-48 hours
## 📜 Legal
By reporting a security vulnerability, you agree to:
- Allow us reasonable time to investigate and mitigate the issue
- Not publicly disclose the vulnerability until we have had a chance to address it
- Make a good faith effort to avoid privacy violations, destruction of data, and interruption or degradation of our services
## 🔄 Policy Updates
This security policy may be updated from time to time. We will notify users of any significant changes through our standard communication channels.
**Last Updated**: September 2024

128
.github/SUPPORT.md vendored Normal file
View File

@@ -0,0 +1,128 @@
# Support
## 🆘 Getting Help
We're here to help you get the most out of ALwrity! Here are the best ways to get support:
### 📚 Documentation
- **[Main Documentation](https://github.com/AJaySi/ALwrity/wiki)** - Comprehensive guides and tutorials
- **[API Documentation](https://github.com/AJaySi/ALwrity/wiki/API-Documentation)** - Complete API reference
- **[Setup Guide](https://github.com/AJaySi/ALwrity/wiki/Setup-Guide)** - Installation and configuration
- **[User Guide](https://github.com/AJaySi/ALwrity/wiki/User-Guide)** - How to use ALwrity features
### 💬 Community Support
- **[GitHub Discussions](https://github.com/AJaySi/ALwrity/discussions)** - Ask questions and share ideas
- **[GitHub Issues](https://github.com/AJaySi/ALwrity/issues)** - Report bugs and request features
- **[Discord Community](https://discord.gg/alwrity)** - Real-time chat and support (coming soon)
### 🐛 Bug Reports
If you encounter a bug:
1. Check existing [issues](https://github.com/AJaySi/ALwrity/issues) first
2. Use our [bug report template](https://github.com/AJaySi/ALwrity/issues/new?template=bug_report.md)
3. Include detailed steps to reproduce the issue
4. Provide error logs and screenshots when possible
### ✨ Feature Requests
Have an idea for a new feature?
1. Check existing [feature requests](https://github.com/AJaySi/ALwrity/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement)
2. Use our [feature request template](https://github.com/AJaySi/ALwrity/issues/new?template=feature_request.md)
3. Provide detailed use cases and mockups if possible
## 🚀 Quick Start
### Installation
```bash
# Clone the repository
git clone https://github.com/AJaySi/ALwrity.git
cd ALwrity
# Backend setup
cd backend
pip install -r requirements.txt
python start_alwrity_backend.py
# Frontend setup (in a new terminal)
cd frontend
npm install
npm start
```
### Common Issues
#### Backend Won't Start
- Check Python version (3.10+ required)
- Verify all dependencies are installed: `pip install -r requirements.txt`
- Check if port 8000 is available
- Review error logs in the terminal
#### Frontend Build Errors
- Check Node.js version (18+ required)
- Clear node_modules and reinstall: `rm -rf node_modules && npm install`
- Check for TypeScript errors: `npm run type-check`
#### API Connection Issues
- Verify backend is running on http://localhost:8000
- Check CORS settings in backend configuration
- Ensure API keys are properly configured
## 🔧 Troubleshooting
### Performance Issues
- Check system resources (CPU, RAM)
- Review database query performance
- Monitor API rate limits
- Clear browser cache and cookies
### Authentication Problems
- Verify API keys are correct
- Check token expiration
- Clear browser storage
- Review authentication logs
### Content Generation Issues
- Verify AI service API keys
- Check internet connectivity
- Review content generation logs
- Ensure sufficient API credits
## 📞 Contact Information
### Primary Support
- **GitHub Issues**: [Create an issue](https://github.com/AJaySi/ALwrity/issues/new)
- **GitHub Discussions**: [Join the discussion](https://github.com/AJaySi/ALwrity/discussions)
- **Email**: [support@alwrity.com](mailto:support@alwrity.com)
### Development Team
- **Lead Developer**: [@AJaySi](https://github.com/AJaySi)
- **Contributors**: [@uniqueumesh](https://github.com/uniqueumesh), [@DikshaDisciplines](https://github.com/DikshaDisciplines)
## 🕒 Response Times
- **Critical Issues**: 24 hours
- **Bug Reports**: 2-3 business days
- **Feature Requests**: 1 week
- **General Questions**: 3-5 business days
## 📖 Additional Resources
### Learning Materials
- **[Video Tutorials](https://youtube.com/alwrity)** - Step-by-step video guides
- **[Blog Posts](https://blog.alwrity.com)** - Tips, tricks, and best practices
- **[Case Studies](https://github.com/AJaySi/ALwrity/wiki/Case-Studies)** - Real-world usage examples
### Community
- **[Contributing Guide](CONTRIBUTING.md)** - How to contribute to ALwrity
- **[Code of Conduct](CODE_OF_CONDUCT.md)** - Community guidelines
- **[Roadmap](https://github.com/AJaySi/ALwrity/wiki/Roadmap)** - Upcoming features and improvements
## 🎯 Pro Tips
1. **Join our community** - Get help faster and share your experiences
2. **Search before asking** - Many questions have already been answered
3. **Provide context** - Include relevant details when asking for help
4. **Be patient** - We're a small team working hard to help everyone
5. **Contribute back** - Help others by sharing your solutions
---
**We're here to help you succeed with ALwrity!** 🚀

85
.github/pull_request_template.md vendored Normal file
View File

@@ -0,0 +1,85 @@
# 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
- [ ] 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
## 🔍 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!** 🎉