Contribution and Development Guidelines

Thanks for your interest in contributing to this project! We welcome and appreciate contributions.

If you have questions, please create a Github issue.

Setting Up Development Environment

Please refer to the Development Guide for more information.

Submit a PR

Pull Request Title

As described here, a valid PR title should begin with one of the following prefixes:

feat: A new feature
fix: A bug fix
docs: Documentation only changes
style: Changes that do not affect the meaning of the code (white space, formatting, missing semi-colons, etc)
refactor: A code change that neither fixes a bug nor adds a feature
perf: A code change that improves performance
test: Adding missing tests or correcting existing tests
build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
ci: Changes to RisingWave CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
chore: Other changes that don't modify src or test files
revert: Reverts a previous commit

For example, a PR title could be:

refactor: modify executor protobuf package path
feat(execution): enable comparison between nullable data arrays, where (execution) means that this PR mainly focuses on the execution component.

You may also check out previous PRs in the PR list.

Pull Request Description

If your PR is small (such as a typo fix), you can go brief.
If it is large and you have changed a lot, it's better to write more details.