|
| 1 | +# Contributing to confluent-kafka-python |
| 2 | + |
| 3 | +Thank you for your interest in contributing to confluent-kafka-python! This document provides guidelines and best practices for contributing to this project. |
| 4 | + |
| 5 | +## Table of Contents |
| 6 | + |
| 7 | +- [Getting Started](#getting-started) |
| 8 | +- [Development Environment Setup](#development-environment-setup) |
| 9 | +- [Code Style and Standards](#code-style-and-standards) |
| 10 | +- [Testing](#testing) |
| 11 | +- [Submitting Changes](#submitting-changes) |
| 12 | +- [Reporting Issues](#reporting-issues) |
| 13 | +- [Community Guidelines](#community-guidelines) |
| 14 | + |
| 15 | +## Getting Started |
| 16 | + |
| 17 | +### Ways to Contribute |
| 18 | + |
| 19 | +- **Bug Reports**: Report bugs and issues you encounter |
| 20 | +- **Feature Requests**: Suggest new features or improvements |
| 21 | +- **Code Contributions**: Fix bugs, implement features, or improve documentation |
| 22 | +- **Documentation**: Improve existing docs or add new documentation |
| 23 | +- **Testing**: Help improve test coverage and quality |
| 24 | + |
| 25 | +### Before You Start |
| 26 | + |
| 27 | +1. Check existing [issues](../../issues) to see if your bug/feature has already been reported |
| 28 | +2. For major changes, open an issue first to discuss the proposed changes |
| 29 | +3. Fork the repository and create a feature branch for your work |
| 30 | + |
| 31 | +## Development Environment Setup |
| 32 | + |
| 33 | +For complete development environment setup instructions, including prerequisites, virtual environment creation, and dependency installation, see the [Development Environment Setup section in DEVELOPER.md](DEVELOPER.md#development-environment-setup). |
| 34 | + |
| 35 | +## Code Style and Standards |
| 36 | + |
| 37 | +### Python Code Style |
| 38 | + |
| 39 | +- **PEP 8**: Follow [PEP 8](https://pep8.org/) style guidelines as a default, with exceptions captured in the `tox.ini` flake8 rules for modern updates to the recommendations |
| 40 | +- **Docstrings**: Use Google-style docstrings for all public functions and classes |
| 41 | + |
| 42 | +### Code Formatting |
| 43 | + |
| 44 | +We use automated tools to maintain consistent code style: |
| 45 | + |
| 46 | +```bash |
| 47 | +# Install formatting tools |
| 48 | +pip install flake8 |
| 49 | + |
| 50 | +# Check style |
| 51 | +flake8 src/ tests/ |
| 52 | +``` |
| 53 | + |
| 54 | +### Naming Conventions |
| 55 | + |
| 56 | +- **Functions and Variables**: `snake_case` |
| 57 | +- **Classes**: `PascalCase` |
| 58 | +- **Constants**: `UPPER_SNAKE_CASE` |
| 59 | +- **Private Methods/Objects**: Prefix with single underscore `_private_method` |
| 60 | + |
| 61 | +### Documentation |
| 62 | + |
| 63 | +- All public APIs must have docstrings |
| 64 | +- Include examples in docstrings when helpful |
| 65 | +- Keep docstrings concise but complete |
| 66 | +- Update relevant documentation files when making changes |
| 67 | + |
| 68 | +## Testing |
| 69 | + |
| 70 | +### Running Tests |
| 71 | + |
| 72 | +See [tests/README.md](tests/README.md) for comprehensive testing instructions. |
| 73 | + |
| 74 | +### Test Requirements |
| 75 | + |
| 76 | +- **Unit Tests**: All new functionality must include unit tests |
| 77 | +- **Integration Tests**: Add integration tests for complex features |
| 78 | +- **Test Coverage**: Maintain or improve existing test coverage |
| 79 | +- **Test Naming**: Use descriptive test names that explain what is being tested |
| 80 | + |
| 81 | +### Test Structure |
| 82 | + |
| 83 | +```python |
| 84 | +def test_feature_should_behave_correctly_when_condition(): |
| 85 | + # Arrange |
| 86 | + setup_data = create_test_data() |
| 87 | + |
| 88 | + # Act |
| 89 | + result = function_under_test(setup_data) |
| 90 | + |
| 91 | + # Assert |
| 92 | + assert result.expected_property == expected_value |
| 93 | +``` |
| 94 | + |
| 95 | +## Submitting Changes |
| 96 | + |
| 97 | +### Pull Request Process |
| 98 | + |
| 99 | +1. **Create Feature Branch** |
| 100 | + ```bash |
| 101 | + git checkout -b feature/your-feature-name |
| 102 | + # or |
| 103 | + git checkout -b fix/issue-number-description |
| 104 | + ``` |
| 105 | + |
| 106 | +2. **Make Your Changes** |
| 107 | + - Write clean, well-documented code |
| 108 | + - Add appropriate tests |
| 109 | + - Update documentation if needed |
| 110 | + - Add an entry to the CHANGELOG.md file for the proposed change |
| 111 | + |
| 112 | +3. **Test Your Changes** |
| 113 | + Refer to [tests/README.md](tests/README.md) |
| 114 | + |
| 115 | +4. **Commit Your Changes** |
| 116 | + ```bash |
| 117 | + git add . |
| 118 | + git commit -m "Clear, descriptive commit message" |
| 119 | + ``` |
| 120 | + |
| 121 | + **Commit Message Guidelines:** |
| 122 | + - Use present tense ("Add feature" not "Added feature") |
| 123 | + - Keep first line under 50 characters |
| 124 | + - Reference issue numbers when applicable (#123) |
| 125 | + - Include breaking change notes if applicable |
| 126 | + |
| 127 | +5. **Push and Create Pull Request** |
| 128 | + ```bash |
| 129 | + git push origin feature/your-feature-name |
| 130 | + ``` |
| 131 | + |
| 132 | + Then create a pull request through GitHub's interface. |
| 133 | + |
| 134 | +### Pull Request Guidelines |
| 135 | + |
| 136 | +- **Title**: Clear and descriptive |
| 137 | +- **Description**: Explain what changes you made and why |
| 138 | +- **Linked Issues**: Reference related issues using "Fixes #123" or "Relates to #123" |
| 139 | +- **Labels**: Review available issue/PR labels and apply relevant ones to help with categorization and triage |
| 140 | +- **Documentation**: Update documentation for user-facing changes |
| 141 | +- **Tests**: Include appropriate tests |
| 142 | +- **Breaking Changes**: Clearly mark any breaking changes |
| 143 | + |
| 144 | +### Code Review Process |
| 145 | + |
| 146 | +- All pull requests require review before merging |
| 147 | +- Address reviewer feedback promptly |
| 148 | +- Keep discussions respectful and constructive |
| 149 | +- Be open to suggestions and alternative approaches |
| 150 | + |
| 151 | +## Reporting Issues |
| 152 | + |
| 153 | +### Using Labels |
| 154 | + |
| 155 | +When creating issues or pull requests, please review the available labels and apply those that are relevant to your submission. This helps maintainers categorize and prioritize work effectively. Common label categories include (look at available labels / other issues for options): |
| 156 | + |
| 157 | +- **Type**: bug, enhancement, documentation, question |
| 158 | +- **Priority**: high, medium, low |
| 159 | +- **Component**: producer, consumer, admin, schema-registry, etc |
| 160 | +- **Status**: needs-investigation, help-wanted, good-first-issue, etc |
| 161 | + |
| 162 | +### Bug Reports |
| 163 | + |
| 164 | +When reporting bugs, please include: |
| 165 | + |
| 166 | +- **Clear Title**: Describe the issue concisely |
| 167 | +- **Environment**: Python version, OS, library versions |
| 168 | +- **Steps to Reproduce**: Detailed steps to reproduce the issue |
| 169 | +- **Expected Behavior**: What you expected to happen |
| 170 | +- **Actual Behavior**: What actually happened |
| 171 | +- **Code Sample**: Minimal code that demonstrates the issue |
| 172 | +- **Error Messages**: Full error messages and stack traces |
| 173 | +- **Client Configuration**: Specify how the client was configured and setup |
| 174 | +- **Logs**: Client logs when possible |
| 175 | +- **Labels**: Apply relevant labels such as "bug" and component-specific labels |
| 176 | + |
| 177 | +### Feature Requests |
| 178 | + |
| 179 | +For feature requests, please include: |
| 180 | + |
| 181 | +- **Use Case**: Describe the problem you're trying to solve |
| 182 | +- **Proposed Solution**: Your idea for how to address it |
| 183 | +- **Alternatives**: Other solutions you've considered |
| 184 | +- **Additional Context**: Any other relevant information |
| 185 | +- **Labels**: Apply relevant labels such as "enhancement" and component-specific labels |
| 186 | + |
| 187 | +## Community Guidelines |
| 188 | + |
| 189 | +### Code of Conduct |
| 190 | + |
| 191 | +This project follows the [Contributor Covenant Code of Conduct](https://www.contributor-covenant.org/). By participating, you agree to uphold this code. |
| 192 | + |
| 193 | +### Communication |
| 194 | + |
| 195 | +- **Be Respectful**: Treat all community members with respect |
| 196 | +- **Be Constructive**: Provide helpful feedback and suggestions |
| 197 | +- **Be Patient**: Remember that maintainers and contributors volunteer their time |
| 198 | +- **Be Clear**: Communicate clearly and provide sufficient context |
| 199 | + |
| 200 | +### Getting Help |
| 201 | + |
| 202 | +- **Issues**: Use GitHub issues for bug reports and feature requests |
| 203 | +- **Discussions**: Use GitHub Discussions for questions and general discussion |
| 204 | +- **Documentation**: Check existing documentation before asking questions |
| 205 | + |
| 206 | +## Recognition |
| 207 | + |
| 208 | +Contributors are recognized in the following ways: |
| 209 | + |
| 210 | +- Contributors are listed in the project's contributor history |
| 211 | +- Significant contributions may be mentioned in release notes |
| 212 | + |
| 213 | +## License |
| 214 | + |
| 215 | +By contributing to this project, you agree that your contributions will be licensed under the same license as the project (see LICENSE file). |
| 216 | + |
| 217 | +--- |
| 218 | + |
| 219 | +Thank you for contributing to confluent-kafka-python! Your contributions help make this project better for everyone. |
0 commit comments