How to contribute to Flink Agents

Thank you for your intention to contribute the Flink Agents project!

Report a bug

Search in the issues to see if the bug has already been reported. If so, please add a comment to the existing issue instead of opening a new one.
If not, please open a new Bug Report issue.

Search in the issues to see if the feature has already been requested. If so, please add a comment to the existing issue instead of opening a new one.
If not, please open a new Feature Request.

For hotfix commits (typo fixes, minor pure refactors, etc.) that does not introduce any behavior changes, please open a pull request directly.
For other code changes, please open an issue about it and make sure there's at least one committer supports it before opening the pull request. And please link the issue in the pull request.
Please add the relevant components in the PR title. E.g., [api], [runtime], [java], [python], [hotfix], etc.

Minor design changes can be discussed directly in the issue.
Significant design changes should be discussed as ideas with proper design docs. All issues for conducting the changes should link to the discussion thread.

Run all the UT with the following command:

./tools/ut.sh

Only run Java UT:

./tools/ut.sh -j

Only run Python UT:

./tools/ut.sh -p

Run the following command to format the code:

./tools/lint.sh

Run the following command to fix the license headers:

./tools/check-license.sh