Contributing Guide
Getting Support
Need help with FraiseQL? There are several ways to get support depending on your question or issue.
Quick Questions and Discussion
Section titled “Quick Questions and Discussion”Discord Community
Section titled “Discord Community”The fastest way to get answers and connect with other FraiseQL users.
- URL: discord.gg/fraiseql
- Channels:
#general— General discussion and announcements#help— Questions and troubleshooting#show-and-tell— Share your projects#announcements— Important updates
- Response Time: Usually within minutes during business hours
- Best for: Quick questions, real-time discussion, community interaction
GitHub Discussions
Section titled “GitHub Discussions”For longer-form discussions and feature requests.
- URL: github.com/fraiseql/fraiseql/discussions
- Categories: Ideas and Feature Requests, Q&A, Show and Tell, General
- Response Time: 1-3 days typically
- Best for: Feature requests, architectural questions, detailed technical discussions
Bug Reports and Issues
Section titled “Bug Reports and Issues”GitHub Issues
Section titled “GitHub Issues”Report bugs and request features on GitHub.
- URL: github.com/fraiseql/fraiseql/issues
- Before reporting, check if your issue already exists
- Include:
- FraiseQL version
- Python/Node/Go version
- Database and version
- Minimal reproducible example
- Expected behavior
- Actual behavior
- Error message or traceback
Response Time: Critical bugs prioritized; others within 1 week
Commercial Support
Section titled “Commercial Support”For enterprise support, SLAs, and dedicated assistance:
- Email: support@fraiseql.dev
- Services:
- Priority issue resolution
- Architecture consultation
- Custom integration support
- Training and onboarding
- SLA guarantees (1-4 hour response)
- Dedicated support contact
- Best for: Production deployments, critical issues, team training
Choosing the Right Channel
Section titled “Choosing the Right Channel”| Question Type | Best Channel | Response Time |
|---|---|---|
| Quick question | Discord #help | Minutes |
| Bug report | GitHub Issues | 1 week |
| Feature idea | GitHub Discussions | 1-3 days |
| Urgent production issue | support@fraiseql.dev | 1-4 hours |
| Architecture advice | GitHub Discussions | 1-3 days |
| Show and tell | Discord #show-and-tell | Varies |
| Security issue | security@fraiseql.dev | Same day |
| Documentation problem | GitHub Issues + Discord | 1-7 days |
| Deployment help | support@fraiseql.dev | 1-4 hours |
| Performance optimization | Discord or Discussions | Varies |
Reporting Security Issues
Section titled “Reporting Security Issues”Instead:
- Email security@fraiseql.dev
- Include:
- Vulnerability description
- Affected FraiseQL versions
- Steps to reproduce (if possible)
- Potential impact
- We will acknowledge within 24 hours and work on a fix
For more details, see our Security Policy.
What to Include When Asking for Help
Section titled “What to Include When Asking for Help”For General Questions
Section titled “For General Questions”- What you’re trying to achieve
- What you’ve already tried
- Any error messages or unexpected behavior
- FraiseQL version and language SDK version
For Bug Reports
Section titled “For Bug Reports”- FraiseQL version:
fraiseql --version - SDK version (Python, TypeScript, etc.)
- Database: PostgreSQL/MySQL/SQLite/SQL Server
- Database version
- Minimal reproducible example (code that reproduces the issue)
- Full error message and traceback
- Expected behavior vs actual behavior
- Environment: Docker/Kubernetes/Local/Production
For Performance Issues
Section titled “For Performance Issues”- Current performance metrics (latency, throughput)
- Expected performance
- Database statistics (table sizes, index status)
- Query or operation that’s slow
- Deployment environment (machine specs, Docker limits, etc.)
For Deployment Issues
Section titled “For Deployment Issues”- Platform (AWS/GCP/Azure/Kubernetes/Docker)
- Deployment method
- Configuration details (relevant environment variables, without secrets)
- Error messages and logs
Etiquette Guidelines
Section titled “Etiquette Guidelines”- Search first — your question may already be answered
- Be specific — vague questions get vague answers
- Be respectful — we’re all volunteers or working in our spare time
- Share code properly — use code blocks or GitHub gists
- Avoid cross-posting — ask in one place, wait for response
- Update others — if you solve your own problem, share the solution
- Say thanks — a simple “thanks!” goes a long way
Documentation and Self-Service Resources
Section titled “Documentation and Self-Service Resources”- Troubleshooting Guide — Common issues and solutions
- Database-Specific Guides — PostgreSQL, MySQL, SQLite, SQL Server
- Getting Started Guide — Start here for new users
- API Reference — Complete API documentation
- Deployment Guides — How to deploy FraiseQL
Status and Roadmap
Section titled “Status and Roadmap”- Status Page: status.fraiseql.dev — Check service status
- GitHub Releases: github.com/fraiseql/fraiseql/releases — Latest updates
- Roadmap: GitHub Projects — What’s planned
Thank you for being part of the FraiseQL community!
Code of Conduct