# Community

Join the Flock community! Connect with other developers, get help, and contribute to the project.

---

## 💬 Get Help & Connect

<div class="grid cards" markdown>

-   **💡 Discussions**

    ---

    Ask questions, share ideas, and connect with the community.

    [:octicons-arrow-right-24: GitHub Discussions](https://github.com/whiteducksoftware/flock/discussions)

-   **🐛 Issues**

    ---

    Report bugs, request features, and track development.

    [:octicons-arrow-right-24: GitHub Issues](https://github.com/whiteducksoftware/flock/issues)

-   **📦 PyPI**

    ---

    View releases, download packages, and check version history.

    [:octicons-arrow-right-24: flock-core on PyPI](https://pypi.org/project/flock-core/)

-   **🔧 GitHub**

    ---

    Browse source code, fork the project, and submit pull requests.

    [:octicons-arrow-right-24: GitHub Repository](https://github.com/whiteducksoftware/flock)

</div>

---

## 🤝 How to Get Help

### 1. Search Documentation

Use the search bar (press `/` to focus) to find:
- Installation instructions
- API reference
- Configuration options
- Example code

### 2. Check Discussions

Before asking a question:
- Search [existing discussions](https://github.com/whiteducksoftware/flock/discussions)
- Browse the [Q&A category](https://github.com/whiteducksoftware/flock/discussions/categories/q-a)
- Look for similar issues

### 3. Ask the Community

If you can't find an answer:
- **Questions** → [Start a Discussion](https://github.com/whiteducksoftware/flock/discussions/new?category=q-a)
- **Bug Reports** → [Open an Issue](https://github.com/whiteducksoftware/flock/issues/new)
- **Feature Requests** → [Open an Issue](https://github.com/whiteducksoftware/flock/issues/new)

---

## 🎯 Discussion Categories

### 💡 Q&A
Ask and answer questions about using Flock.

**Popular topics:**
- Getting started
- Agent design patterns
- Performance optimization
- Production deployment

### 📣 Announcements
Stay updated with release notes and project news.

**What you'll find:**
- New feature announcements
- Breaking changes
- Security updates
- Roadmap updates

### 💬 General
Discuss anything Flock-related.

**Talk about:**
- Use cases and success stories
- Architecture patterns
- Integration ideas
- Best practices

### 🌟 Show and Tell
Share what you've built with Flock!

**Show us:**
- Your applications
- Custom components
- Example code
- Benchmarks and comparisons

---

## 🐛 Reporting Issues

### Bug Reports

**Before reporting:**
1. Search [existing issues](https://github.com/whiteducksoftware/flock/issues)
2. Check if it's already fixed in latest version
3. Verify it's reproducible

**Include in your report:**
- Flock version (`pip show flock-core`)
- Python version (`python --version`)
- Operating system
- Minimal reproducible example
- Expected vs actual behavior
- Error messages and stack traces

**[Report a bug →](https://github.com/whiteducksoftware/flock/issues/new)**

### Feature Requests

**Before requesting:**
1. Check if it's already planned
2. Search existing feature requests
3. Consider if it fits Flock's philosophy

**Include in your request:**
- Use case description
- Proposed API or behavior
- Alternative solutions you've considered
- Why this matters to you

**[Request a feature →](https://github.com/whiteducksoftware/flock/issues/new)**

---

## 🚀 Contributing

We welcome contributions of all kinds!

### Ways to Contribute

**Code contributions:**
- Fix bugs
- Implement features
- Improve performance
- Add tests

**Documentation:**
- Fix typos
- Improve clarity
- Add examples
- Write guides

**Community:**
- Answer questions
- Review pull requests
- Share your experience
- Report issues

### Getting Started

1. **Fork the repository**
   ```bash
   git clone https://github.com/whiteducksoftware/flock.git
   cd flock
   ```

2. **Set up development environment**
   ```bash
   # Install with development dependencies
   uv sync --dev --all-groups --all-extras

   # Or with pip
   pip install -e ".[dev]"
   ```

3. **Run tests**
   ```bash
   pytest tests/
   ```

4. **Make your changes**
   - Follow existing code style
   - Add tests for new features
   - Update documentation
   - Run linters and formatters

5. **Submit pull request**
   - Describe your changes
   - Reference related issues
   - Ensure tests pass

**[See full contributing guide →](https://github.com/whiteducksoftware/flock/blob/main/CONTRIBUTING.md)**

---

## 📜 Code of Conduct

We are committed to providing a welcoming and inclusive environment.

**Our standards:**
- Be respectful and inclusive
- Welcome newcomers
- Give constructive feedback
- Focus on what's best for the community

**Enforcement:**
Unacceptable behavior may result in temporary or permanent ban from the community.

**[Read full Code of Conduct →](https://github.com/whiteducksoftware/flock/blob/main/CODE_OF_CONDUCT.md)**

---

## 🎓 Resources

### Learning Resources
- **[Documentation](../getting-started/index.md)** - Official guides and reference
- **[Examples](../examples/index.md)** - Working code samples
- **[Blog Posts](https://github.com/whiteducksoftware/flock/discussions)** - Tutorials and insights

### Project Resources
- **[Changelog](https://github.com/whiteducksoftware/flock/releases)** - Version history
- **[Roadmap](https://github.com/whiteducksoftware/flock/discussions)** - Future plans
- **[Architecture](../getting-started/concepts.md)** - Design philosophy

---

## 🏆 Contributors

Thank you to everyone who has contributed to Flock!

**[View all contributors →](https://github.com/whiteducksoftware/flock/graphs/contributors)**

### Top Contributors

Your contributions make Flock better for everyone:
- Bug fixes and features
- Documentation improvements
- Community support
- Testing and feedback

---

## 📰 Stay Updated

### Release Notes
Subscribe to releases on GitHub to get notified:
- New features
- Breaking changes
- Bug fixes
- Performance improvements

**[Watch releases →](https://github.com/whiteducksoftware/flock/releases)**

### Discussions
Follow discussions to stay in the loop:
- Feature announcements
- RFC (Request for Comments)
- Community highlights
- Roadmap updates

**[Follow discussions →](https://github.com/whiteducksoftware/flock/discussions)**

---

## 🌟 Recognition

Built with ❤️ by [white duck GmbH](https://whiteduck.de)

**Technologies:**
- Python 3.10+ with modern async
- OpenTelemetry for distributed tracing
- DuckDB for analytics
- React 19 for dashboard
- Material for MkDocs for documentation

---

## 📞 Contact

### For Users
- **Questions** → [GitHub Discussions](https://github.com/whiteducksoftware/flock/discussions)
- **Bug Reports** → [GitHub Issues](https://github.com/whiteducksoftware/flock/issues)
- **Security Issues** → Email security@whiteduck.de

### For Business
- **Enterprise Support** → Contact [white duck GmbH](https://whiteduck.de)
- **Consulting** → Professional services available
- **Custom Development** → Tailored solutions

---

## ⚖️ License

Flock is open source software licensed under the [MIT License](https://github.com/whiteducksoftware/flock/blob/main/LICENSE).

---

**Join the conversation** → [GitHub Discussions](https://github.com/whiteducksoftware/flock/discussions){ .md-button .md-button--primary }
