Contributing to ZeroIPC¶
We welcome contributions! This guide will help you get started.
Ways to Contribute¶
- Bug Reports - Help us identify issues
- Feature Requests - Suggest new capabilities
- Documentation - Improve guides and examples
- Code Contributions - Fix bugs or add features
- Language Implementations - Add support for new languages
- Examples - Share real-world usage patterns
Getting Started¶
1. Development Setup¶
Follow the development setup guide to:
- Clone the repository
- Install dependencies
- Build all implementations
- Run the test suite
2. Find an Issue¶
Good first contributions:
- Issues labeled
good-first-issue - Documentation improvements
- Example programs
- Test coverage improvements
3. Make Changes¶
Follow our:
- Testing Guidelines - Write and run tests
- Code Style - Match existing conventions
- Commit Messages - Clear and descriptive
4. Submit Pull Request¶
- Create feature branch
- Write tests
- Update documentation
- Submit PR with clear description
Code of Conduct¶
- Be respectful and inclusive
- Welcome newcomers
- Focus on constructive feedback
- Credit others' work
Language Implementation¶
Want to add Rust, Go, or another language?
See Adding Language Support for:
- Binary format requirements
- Minimum structure set
- Cross-language testing
- Documentation requirements
Documentation Style¶
When writing documentation:
- Be clear - Simple language, avoid jargon
- Be complete - Include examples and edge cases
- Be correct - Test code examples
- Be consistent - Follow existing style
Getting Help¶
- GitHub Discussions - Ask questions
- GitHub Issues - Report bugs
- Pull Requests - Get code review
Thank you for contributing to ZeroIPC!