Community
Welcome to the Stepflow community! Whether you're looking for help, want to report a bug, or interested in contributing, this page will guide you to the right resources.
Getting Helpโ
GitHub Discussionsโ
The best place to ask questions, share ideas, and discuss Stepflow is GitHub Discussions.
Use Discussions for:
- โ Questions about using Stepflow
- ๐ก Feature ideas and proposals
- ๐ฃ๏ธ General discussions about workflows and architecture
- ๐ข Announcements and updates
- ๐ Sharing your Stepflow projects and use cases
Documentationโ
Our documentation is your first stop for learning about Stepflow:
- ๐ Introduction - Understand Stepflow's architecture
- ๐ Getting Started - Run your first workflow
- ๐ Workflows - Learn to write workflows
- ๐ Components - Build and use components
- โ๏ธ Configuration - Configure your environment
- ๐ข Deployment - Deploy to production
Examplesโ
Check out our examples directory for real-world use cases:
- Basic workflows
- Custom Python components
- Data pipelines
- LangChain integration
- OpenAI integration
- Kubernetes batch processing
- Production model serving
Reporting Issuesโ
Bug Reportsโ
Found a bug? Please report it on GitHub Issues.
Before creating an issue:
- Search existing issues to avoid duplicates
- Check if it's already fixed in the latest release
- Gather relevant information (version, OS, error messages)
When reporting a bug, include:
- Clear description of the problem
- Steps to reproduce
- Expected vs actual behavior
- Stepflow version (
stepflow --version) - Operating system and environment details
- Relevant logs or error messages
- Minimal workflow example that demonstrates the issue
Security Issuesโ
If you discover a security vulnerability, please do not open a public issue. Instead, email the maintainers directly or use GitHub's private security reporting feature.
Feature Requestsโ
Have an idea for a new feature or improvement? We'd love to hear it!
Process:
- Check existing discussions to see if it's already proposed
- Start a new discussion in the "Ideas" category
- Describe your use case and why the feature would be valuable
- Engage with community feedback
Popular feature requests may be promoted to GitHub Issues for implementation tracking.
Contributingโ
We welcome contributions from everyone! Whether you're fixing a typo or implementing a major feature, your help is appreciated.
Types of Contributionsโ
- ๐ Bug fixes - Help us squash bugs
- โจ New features - Add functionality
- ๐ Documentation - Improve docs and examples
- ๐งช Tests - Increase code coverage
- ๐จ Examples - Create new workflow examples
- ๐ Code review - Review pull requests
Getting Startedโ
- Read our Contributing Guide for development setup
- Check good first issues for beginner-friendly tasks
- Join the conversation in GitHub Discussions
All contributors must sign the Individual Contributor License Agreement (ICLA) before their first contribution. Run python scripts/sign_icla.py in the repository.
Community Guidelinesโ
We are committed to providing a welcoming and inclusive environment for everyone.
Our Principlesโ
- Be respectful - Treat everyone with respect and kindness
- Be inclusive - Welcome people of all backgrounds and experience levels
- Be constructive - Provide helpful feedback and assume good intentions
- Be collaborative - Work together to solve problems
- Be patient - Remember that everyone is learning
Expected Behaviorโ
- Use welcoming and inclusive language
- Respect differing viewpoints and experiences
- Accept constructive criticism gracefully
- Focus on what's best for the community
- Show empathy towards other community members
Unacceptable Behaviorโ
- Harassment, discrimination, or offensive comments
- Personal attacks or trolling
- Publishing others' private information
- Spam or excessive self-promotion
- Any conduct that could reasonably be considered inappropriate
If you experience or witness unacceptable behavior, please report it to the project maintainers.
Stay Connectedโ
GitHubโ
- ๐ฆ Repository - Source code and releases
- ๐ฌ Discussions - Community forum
- ๐ Issues - Bug reports and feature tracking
- ๐ Pull Requests - Code contributions
Updatesโ
- ๐ Release Notes - Latest releases and changelogs
- ๐ Blog - Articles and announcements
- โญ Star the repo - Stay updated on GitHub
Socialโ
- ๐ฆ Follow development updates on social media (coming soon)
- ๐ง Subscribe to our newsletter (coming soon)
Thank Youโ
Thank you for being part of the Stepflow community! Your participation, whether through questions, bug reports, feature ideas, or code contributions, helps make Stepflow better for everyone.
We look forward to seeing what you build with Stepflow! ๐