713f6e46fe
CHANGES - Add CODE_OF_CONDUCT defining respectful, collaborative community behavior - Add CONTRIBUTING with setup, testing, PR, changelog requirements - Add SECURITY policy with reporting process and response timelines - Add SUPPORT guide for bugs, features, discussions, expectations - Add docs README indexing guides, quick starts, contributor essentials
3.7 KiB
Support
Getting Help with Fabric
Need help with Fabric? Here are the best ways to get assistance:
📖 Documentation First
Before reaching out, check these resources:
- README.md - Installation, usage, and examples
- docs/ - Detailed documentation
- Patterns - Browse available AI patterns
🐛 Bug Reports
Found a bug? Please create an issue:
Include:
- Fabric version (
fabric --version) - Operating system
- Steps to reproduce
- Expected vs actual behavior
- Error messages/logs
💡 Feature Requests
Have an idea for Fabric? We'd love to hear it:
Describe:
- What you want to achieve
- Why it would be useful
- How you envision it working
- Any alternatives you've considered
🤔 Questions & Discussions
For general questions, usage help, or community discussion:
Great for:
- "How do I...?" questions
- Sharing patterns you've created
- Getting community advice
- Feature brainstorming
🏷️ Issue Labels
When creating issues, maintainers will add appropriate labels:
bug- Something isn't workingenhancement- New feature requestdocumentation- Documentation improvementshelp wanted- Community contributions welcomegood first issue- Great for new contributorsquestion- General questionspattern- Related to AI patterns
📋 Issue Templates
We provide templates to help you create detailed reports:
- Bug Report - Structured bug reporting
- Feature Request - Detailed feature proposals
- Pattern Submission - New pattern contributions
🔒 Security Issues
DO NOT create public issues for security vulnerabilities.
See our Security Policy for proper reporting procedures.
⚡ Response Times
We're a community-driven project with volunteer maintainers:
- Bugs: We aim to acknowledge within 48 hours
- Features: Response time varies based on complexity
- Questions: Community often responds quickly
- Security: See security policy for timelines
🛠️ Self-Help Tips
Before creating an issue, try:
- Update Fabric:
go install github.com/danielmiessler/fabric/cmd/fabric@latest - Check existing issues: Someone might have the same problem
- Run setup:
fabric --setupcan fix configuration issues - Test minimal example: Isolate the problem
🤝 Community Guidelines
When asking for help:
- Be specific and provide context
- Include relevant details and error messages
- Be patient - maintainers are volunteers
- Help others when you can
- Say thanks when someone helps you
📞 Emergency Contact
For urgent security issues only:
- Email: security@fabric.ai (if available)
- Maintainer: daniel@danielmiessler.com
🎯 What We Can Help With
✅ We can help with:
- Installation and setup issues
- Usage questions and examples
- Bug reports and fixes
- Feature discussions
- Pattern creation guidance
- Integration questions
❌ We cannot help with:
- Custom development for your specific use case
- Troubleshooting your specific AI provider issues
- General AI or programming tutorials
- Commercial support agreements
💪 Contributing Back
The best way to get help is to help others:
- Answer questions in discussions
- Improve documentation
- Share useful patterns
- Report bugs clearly
- Review pull requests
See our Contributing Guide for details.
Remember: We're all here to make Fabric better. Be kind, be helpful, and let's build something amazing together!