Welcome to the Scribely contribution hub! This directory contains templates and workflows to help make contributing smooth and efficient.

We've created several issue templates to help you report problems and suggest improvements:

Use this when something isn't working as expected. Please provide:

• Clear reproduction steps
• Expected vs actual behavior
• Environment details
• Screenshots or logs if applicable

Got a great idea? We'd love to hear it! Include:

• Problem statement (what need does this address?)
• Proposed solution
• Alternative approaches considered
• Impact assessment

Found unclear or missing documentation? Help us improve:

• Specify what's confusing or missing
• Suggest better explanations
• Provide examples if helpful

Report slow performance or suggest optimizations:

• Specific metrics (response times, memory usage)
• Steps to reproduce
• Profiling data if available
• Environment details

Important: Use GitHub's private vulnerability reporting for sensitive security issues!

• Go to Security tab → Report vulnerability
• For non-critical security improvements, use the public template

Our PR template includes:

• 📋 Clear description and related issues
• 🎯 Type of change checkboxes
• 🧪 Testing checklist
• 📸 Space for screenshots/demos
• ✅ Quality assurance checklist

1. 🔍 Search existing issues to avoid duplicates
2. 📖 Read our documentation and guides
3. 💬 Join discussions for complex features
4. 🎯 Start with "good first issue" labels if you're new

1. 🍴 Fork the repository
2. 🌿 Create a feature branch
3. 🧪 Write tests for your changes
4. ✅ Ensure all checks pass
5. 📝 Fill out the PR template completely
6. 🎉 Submit your pull request!

• ✨ Follow existing code style
• 🧪 Include tests for new functionality
• 📖 Update documentation as needed
• 🔍 Use meaningful commit messages
• 🚫 No breaking changes without discussion

We use these labels to organize issues:

• bug - Something isn't working
• enhancement - New feature or improvement
• documentation - Documentation improvements
• performance - Performance-related issues
• security - Security-related issues

• critical - Urgent, blocks users
• high - Important, should be addressed soon
• medium - Normal priority
• low - Nice to have

• needs-triage - Needs initial review
• needs-discussion - Requires team discussion
• good first issue - Great for new contributors
• help wanted - Community help appreciated

Our CI/CD pipelines automatically:

• 🧪 Run comprehensive tests
• 🔍 Check code quality and security
• 🐳 Build and test Docker images
• 🚀 Deploy to staging/production
• 📊 Generate coverage reports

• 💬 Use Discussions for questions
• 🏷️ Look for good first issue labels
• 📖 Check our guides in /backend/guides/
• 🤝 Don't hesitate to ask for help in issues/PRs

• 🎯 Keep PRs focused and small
• 📝 Write clear commit messages
• 🧪 Add tests for new features
• 📖 Update docs when needed
• 🔄 Respond to feedback promptly

• 🧪 Run tests locally: cd backend && poetry run pytest
• 🔍 Check linting: poetry run black . && poetry run flake8 .
• 🐳 Test Docker build: docker build -t test .

Every contribution makes Scribely better. Whether it's:

• 🐛 Reporting bugs
• ✨ Adding features
• 📚 Improving docs
• 💬 Helping in discussions
• ⭐ Starring the repo

Your involvement matters! 🚀

Happy coding! 💻✨