Skip to main content

how to contribute

Contributing to Uniffle

Welcome to report Issues or make pull requests. It's recommended to read the following contributing guide first before contributing.

Issues​

We use GitHub Issues to track public bugs and feature requests.

Search Known Issues First​

Please search on Issues to avoid creating duplicate issues.

Reporting New Issues​

  • Be sure to include a title and clear description, as much relevant information as possible.
  • A code sample or an executable test case demonstrating is highly recommended.

Pull Requests​

  • We use master branch as our developing branch.
  • Do not commit/push directly to the master branch. Instead, create a fork and file a pull request.
  • When maintaining a branch, merge frequently with the master.
  • When maintaining a branch, submit pull requests to the master frequently.
  • If you are working on a bigger issue try to split it up into several smaller issues.
  • We reserve full and final discretion over whether we will merge a pull request. Adhering to these guidelines is not a complete guarantee that your pull request will be merged.

Make Pull Requests​

The code team will monitor all pull requests, we run some code check and test on it. After all tests passed and all the review comments addressed, we will accept the PR.

Before submitting a pull request, please make sure the followings are done:

  1. Fork the repo and create your branch from master.
  2. Update code or documentation if you have changed APIs.
  3. Add the copyright notice to the top of any new files you've added.
  4. Check your code lints and checkstyle.
  5. Test and test again your code.

Code Style Guide​

Use Code Style for Java.

  • 2 spaces for indentation rather than tabs