Thank you for your interest in contributing! We love community contributions. Read on to learn how to contribute to AutoMQ. We appreciate first time contributors and we are happy to assist you in getting started. In case of questions, just reach out to us via Wechat Group or Slack!
Before getting started, please review AutoMQ's Code of Conduct. Everyone interacting in Slack or Wechat follow Code of Conduct.
Most of the issues that are open for contributions are tagged with good first issue.
Start with
this tagged issue
The usual workflow of code contribution is:
- Fork the AutoMQ repository.
- Clone the repository locally.
- Create a branch for your feature/bug fix with the format
{YOUR_USERNAME}/{FEATURE/BUG}( e.g.jdoe/source-stock-api-stream-fix) - Make and commit changes.
- Push your local branch to your fork.
- Submit a Pull Request so that we can review your changes.
- Link an existing Issue
that does not include the
needs triagelabel to your Pull Request. A pull request without a linked issue will be closed, otherwise. - Write a PR title and description that follows the Pull Request Handbook and Pull Request Template.
- An AutoMQ maintainer will trigger the CI tests for you and review the code.
- Review and respond to feedback and questions by AutoMQ maintainers.
- Merge the contribution.
Pull Request reviews are done on a regular basis.
:::info Please make sure you respond to our feedback/questions and sign our CLA.
Pull Requests without updates will be closed due inactivity. :::
Guidelines to common code contributions:
| Requirement | Version |
|---|---|
| Compiling requirements | JDK 17 |
| Compiling requirements | Scale 2.13 |
| Running requirements | JDK 17 |
We welcome Pull Requests that enhance the grammar, structure, or fix typos in our documentation.
Another crucial way to contribute is by reporting bugs and helping other users in the community.
You're welcome to enter the Community Slack and help other users or report bugs in Github.
This contributing document is adapted from that of AutoMQ.