Contributing

We welcome any contributions whether it’s,

• Submitting feedback
• Fixing bugs
• Or implementing a new feature.

Please read this guide before making any contributions.

Submit Feedback

The feedback should be submitted by creating an issue at GitHub issues.

Fix Bugs

You may look through the GitHub issues for bugs.

Implement Features

You may look through the GitHub issues for feature requests.

Pull Requests (PR)

1. Fork the repository and create a new branch from the master branch.
2. For bug fixes, add new tests and for new features please add changes to the documentation.
3. Do a PR from your new branch to our main branch of the original idealo/php-rdkafka-ffi repo.

Code Style

• Make sure any new code you introduce has proper code styling according to PRS-12. You should run composer cs-fix before a PR.

Documentation

• Make sure any new code you introduce has proper phpdoc. You may add extra usage documentation under /docs/usage

See work on the documentation locally.

Testing

• Make sure to write tests for any new feature and/or bug fixes. We use phpunit for our testing.

See run tests locally.

Main Contributor List

We maintain a list of main contributors to appreciate all the contributions.