Skip to content

Latest commit

 

History

History
29 lines (23 loc) · 1.39 KB

CONTRIBUTING.md

File metadata and controls

29 lines (23 loc) · 1.39 KB

Contributing guidelines

Pull Request Checklist

Before sending your pull requests, make sure you followed this list.

  • Read contributing guidelines.

  • Open an issue (https://github.com/alibaba/flink-ai-extended/issues)

  • Create a personal fork of the project on Github.

  • Clone the fork on your local machine. Your remote repo on Github is called origin.

  • Add the original repository as a remote called upstream.

  • If you created your fork a while ago be sure to pull upstream changes into your local repository.

  • Create a new branch to work on! Branch from master.

  • Implement/fix your feature, comment your code.

  • Follow the code style of the project, including indentation.

    java example

    python example

    c++ example

  • Run tests.

  • Write or adapt tests as needed.

  • Add or change the documentation as needed.

  • Create a new branch.

  • Push your branch to your fork on Github, the remote origin.

  • From your fork open a pull request in the correct branch. Go for master!

  • Wait for approval.

  • Once the pull request is approved and merged you can pull the changes from upstream to your local repo and delete your extra branches.