Skip to main content

Participate in Contributing

First of all, thank you very much for choosing and using StreamPark, and welcome to join the StreamPark family!

We encourage any form of participation in the community that will eventually become Committer or PPMC Such as:

  • Problems will be encountered via github on the issue form feedback out.
  • Answer the issue questions that others are asking.
  • Help improve the documentation.
  • Help your project add test cases.
  • Add comments to the code.
  • Submit a PR that fixes the bug or Feature.
  • Publish application case practice, scheduling process analysis, or technical articles related to scheduling.
  • Help promote StreamPark, participate in technical conferences or meetup, sharing and more.

Welcome to the contributing team and join open source starting with submitting your first PR.

  • For example, add code comments or find good first issue tags or some very simple issue (misspellings, etc.) and so on, first familiarize yourself with the submission process through the first simple PR.

Note: Contributions are not limited to PR Only, but contribute to the development of the project.

I'm sure you'll benefit from open source by participating in StreamPark!

1. Participate in documentation contributions.​

Refer to the Submit Guide-Document Notice

2. Participate in code contributions.​

Refer to the Submit Guide-Pull Request Notice, Submit Guide-Commit Message Notice

3. How to pick up an Issue and submit a Pull Request.​

If you want to implement a Feature or fix a Bug. Please refer to the following:

  • All bugs and the features are recommended and managed using the GitHub issues(https://github.com/apache/incubator-streampark/issues).
  • If you want to develop a Feature, first reply to the Issue associated with that feature, indicating that you are currently working on it. And set yourself a "deadline" when to Submit the Feature, and add it in the reply comment.
  • It's a good idea to find a mentor (or an instructor) in the core contributors who gives immediate feedback on design and functional implementation.
  • You should create a new branch to start your work, to get the name of the branch refer to the Submit Guide-Pull Request Notice. For example, if you want to complete the feature and submit Issue 111, your branch name should be feature-111. The feature name can be determined after discussion with the instructor.
  • When you're done, send a Pull Request to StreamPark.

If you want to submit a Pull Request to complete a Feature or fix a Bug, it is recommended that you start with the good first issue issues, complete a small function to submit, do not change too many files at a time, changing too many files will also put a lot of pressure on Reviewers, it is recommended to submit them through multiple Pull Requests, not all at once.