apache/celeborn
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity
90ff0dba2f
celeborn/CONTRIBUTING.md
SteNicholas e1c196a71a [CELEBORN-927][DOC] Run dev/reformat before you create a new pull request for code style 
### What changes were proposed in this pull request?

Run `dev/reformat` before you create a new pull request for code style in `CONTRIBUTING.md`.

### Why are the changes needed?

Affects the contribution of creating pull request.

### Does this PR introduce _any_ user-facing change?

No.

### How was this patch tested?

No.

Closes #1859 from SteNicholas/CELEBORN-927.

Authored-by: SteNicholas <programgeek@163.com>
Signed-off-by: zky.zhoukeyong <zky.zhoukeyong@alibaba-inc.com>
2023-08-29 21:42:37 +08:00

1.6 KiB
Raw Blame History

Contributing to Celeborn

Any contributions from the open-source community to improve this project are welcome!

Code Style

This project uses check-style plugins. Run some checks before you create a new pull request.

dev/reformat

If you have changed configuration, run following command to refresh docs.

UPDATE=1 build/mvn clean test -pl common -am -Dtest=none -DwildcardSuites=org.apache.celeborn.ConfigurationSuite

How to Contribute

For collaboration, feel free to contact us on Slack. To report a bug, you can just open a ticket on Jira
and attach the exceptions and your analysis if any. For other improvements, you can contact us or open a Jira ticket first and describe what improvement you would like to do. After reaching a consensus, you can open a pull request and your pull request will get merged after reviewed.

Improvements on the Schedule

There are already some further improvements on the schedule and welcome to contact us for collaboration:

  1. Flink support.
  2. Multi-tenant.
  3. Support Tez.
  4. Rolling upgrade.
  5. Multi-layered storage.
  6. Enhanced flow control.
  7. HA improvement.
  8. Enhanced K8S support.
  9. Support spilled data.
  10. Locality awareness.

Guidelines

Adding RPC Messages

When you add new RPC message, it's recommended to follow raw PB message case, for example RegisterWorker and RegisterWorkerResponse. The RPC messages will be unified into raw PB messages eventually.