Contributing
Welcome contributors!¶
Thank you for your interest in contributing to ddb-lib! We welcome contributions of all kinds, including:
- 📝 Documentation improvements
- 🐛 Bug reports and fixes
- ✨ New features
- 💡 Examples and tutorials
- 🎨 Design improvements
- 🧪 Tests and test coverage
Getting started¶
Whether you're fixing a typo or adding a major feature, we appreciate your help in making ddb-lib better for everyone.
Quick links¶
- Development Setup - Set up your local development environment
- Documentation Guide - Learn how to write and update documentation
- Code of Conduct - Our community guidelines
Ways to contribute¶
Documentation¶
Documentation is crucial for helping developers use ddb-lib effectively. You can contribute by:
- Fixing typos and improving clarity
- Adding missing examples
- Creating new guides and tutorials
- Improving existing explanations
- Adding diagrams and visual aids
See our Documentation Guide for detailed instructions.
Code¶
Code contributions help improve the library's functionality and reliability:
- Fix bugs reported in issues
- Implement new features
- Improve performance
- Add tests
- Refactor code for better maintainability
See our Development Setup guide to get started.
Examples¶
Real-world examples help developers understand how to use the library:
- Create example applications
- Add code snippets to documentation
- Share use cases and patterns
- Contribute to the examples directory
Bug reports¶
Help us identify and fix issues:
- Report bugs with clear reproduction steps
- Suggest improvements
- Provide feedback on documentation
- Test pre-release versions
Contribution process¶
- Fork the repository on GitHub
- Clone your fork locally
- Create a branch for your changes
- Make your changes following our guidelines
- Test your changes thoroughly
- Commit your changes with clear messages
- Push to your fork on GitHub
- Open a pull request with a description of your changes
Code of conduct¶
We are committed to providing a welcoming and inclusive environment for all contributors. Please read and follow our Code of Conduct.
Questions?¶
If you have questions about contributing, feel free to:
- Open a discussion on GitHub
- Ask in pull request comments
- Reach out to maintainers
We're here to help and appreciate your contributions!
Recognition¶
All contributors are recognized in our:
- GitHub contributors list
- Release notes
- Documentation credits
Thank you for making ddb-lib better! 🎉