Contributing¶
Thank you for your interest in contributing to Duckling!
Overview¶
This section covers everything you need to know to contribute effectively.
-
Development Setup
Set up your development environment
-
Code Style
Coding standards and conventions
-
Testing
Writing and running tests
-
Code of Conduct
Community guidelines and standards
Code of Conduct¶
By participating in this project, you agree to abide by our Code of Conduct, which is based on the Contributor Covenant 3.0. We are committed to providing a welcoming and inclusive environment for everyone.
How to Contribute¶
Reporting Bugs¶
- Check existing issues to avoid duplicates
- Create a new issue with:
- Clear, descriptive title
- Steps to reproduce
- Expected vs actual behavior
- Environment details (OS, browser, versions)
- Screenshots if applicable
Suggesting Features¶
- Check existing issues for similar suggestions
- Create a feature request with:
- Clear description of the feature
- Use case and benefits
- Possible implementation approach
Pull Requests¶
- Fork the repository
- Create a feature branch:
git checkout -b feature/your-feature-name - Make your changes
- Write/update tests
- Run tests: Ensure all tests pass
- Commit with clear messages: Follow conventional commits
- Push to your fork
- Create a Pull Request
Review Process¶
- All PRs require at least one approval
- CI checks must pass
- Code coverage should not decrease
- Documentation must be updated if needed
Recognition¶
Contributors will be recognized in:
- CHANGELOG.md for significant contributions
- README.md contributors section
Thank you for contributing to Duckling!