Getting Involved with KServe
Welcome to the KServe community! We're excited to have you contribute to the standard Model Inference Platform on Kubernetes.
Join us🤝!
Ways to Contribute
🐛 Report Issues
Found a bug or have a feature request? Help us improve KServe:
- Bug Reports: Create an issue.
- Feature Requests: Request a feature.
- Documentation: Help improve our docs by submitting PRs.
A good bug report should include:
- Description: Clearly state what you were trying to accomplish and what behavior you observed instead
- Versions: Specify the versions of relevant components:
- KServe version
- Knative version (if using Serverless)
- Kubeflow version (if used with Kubeflow)
- Kubernetes version
- Cloud provider details (if applicable)
- Relevant resource YAMLs, HTTP requests, or log lines
For documentation issues, please use the KServe Website repository.
For Open Inference Protocol (V2) related issues, please use the Open Inference Protocol repository.
🔒 Vulnerability Reports
We strongly encourage you to report security vulnerabilities privately, before disclosing them in any public forums. Only the active maintainers and KServe security group members will receive the reported security vulnerabilities and the issues are treated as top priority.
You can use the following ways to report security vulnerabilities privately:
- Using the KServe repository GitHub Security Advisory (Recommended)
- Using our private security mailing list: kserve-security@lists.lfaidata.foundation
Also read the KServe Security Policy.
💻 Code Contributions
Getting Started
- Fork the Repository: Fork KServe on GitHub.
- Set Up Development Environment: Follow our developer guide.
- Find an Issue: Look for
good first issue
labels. - Submit a Pull Request: Follow our contribution guidelines.
Areas to Contribute
- Core Platform: Improve controller and APIs
- Model Serving Runtimes: Add support for new ML frameworks
- Model Operations: Improve monitoring, logging, and observability
- Documentation: Help improve guides and examples
📝 Documentation
Help make KServe more accessible:
- User Guides: Write tutorials and how-to guides.
- API Documentation: Improve API reference documentation.
- Examples: Create example applications and use cases.
- Translations: Help translate documentation.
🗣️ Community Engagement
Join Our Discussions
Much of the community meets on the CNCF Slack, using the following channels:
- Slack:
- #kserve: General discussion about KServe usage
- #kserve-contributors: Discussion for folks contributing to the KServe project
- #kserve-oip-collaboration: Discussion for Open Inference Protocol and API standardization
To join, create your CNCF Slack account first.
- GitHub Discussions: Participate in GitHub Discussions
Community Meetings
- KServe WG Meeting: Biweekly on Thursdays at 9:00 AM US/Pacific
- Open Inference Protocol WG Meeting: Monthly on Wednesdays at 10:00 AM US/Pacific
Meeting agendas and notes can be accessed in:
Access recordings and stay updated with the community calendar (iCal export file)
🎤 Speaking & Advocacy
Share your KServe experience:
- Conference Talks: Present at conferences and meetups
- Blog Posts: Write about your KServe implementations
- Case Studies: Share your production use cases
- Social Media: Help spread awareness about KServe
Community Guidelines
Code of Conduct
We follow the CNCF Code of Conduct. Please be respectful and inclusive in all interactions.
Communication
- Be Respectful: Treat all community members with respect
- Be Constructive: Provide helpful feedback and suggestions
- Be Patient: Remember that contributors have different experience levels
- Be Inclusive: Welcome newcomers and help them get started
Resources
Documentation
- Developer Guide: Development setup and guidelines
- API Reference: Complete API documentation
- Architecture Guide: Understanding KServe architecture
Getting Help
For Contributors
- Slack: Ask questions in the appropriate Slack channels:
- #kserve for general usage questions
- #kserve-contributors for contribution discussions
- #kserve-oip-collaboration for Open Inference Protocol discussions
- GitHub Issues: Create issues for bugs or questions
- Community Meetings: Get help during our biweekly or monthly community meetings
- Developer Guide: Follow our developer guide to get started with contributions
For Users
- Documentation: Check our comprehensive guides
- Slack: Ask questions in the
#kserve
channel - GitHub Discussions: Ask usage questions
License
KServe is licensed under the Apache 2.0 License. By contributing, you agree to license your contributions under the same license.
Thank You!
Thank you for your interest in contributing to KServe! Your contributions help make model serving on Kubernetes better for everyone.
Feel free to ask questions, engage in discussions, or get involved in KServe's development. KServe, as an open-source project, thrives on the active participation of its community.
Ready to get started? Check out our developer guide or join our Slack community!