Skip to content

Latest commit

 

History

History
30 lines (22 loc) · 1.77 KB

CONTRIBUTING.md

File metadata and controls

30 lines (22 loc) · 1.77 KB
Raw

  1. Please sign the UCX contributors agreement.

  2. Please follow the code style and logging style.

  3. Make sure automatic tests pass.

  4. Request a review by mentioning or requesting a review from the relevant reviewer.

  5. PR which is reviewed and currently waiting for a fix and/or response, will be marked with "Waiting for Author Response" by the reviewer,

  6. In order to address review comments, please push a new commit with the necessary changes.

    1. Do not rebase, squash, amend, or force-push while review is still in progress (comments were already posted and the pull request was not approved yet). Doing so will discard the previous version of the code for which comments were already posted.
    2. If there is a merge conflict with master branch, use merge commit to resolve the conflict (do not rebase)
    3. If force-push was done by accident, please rebase the code on the last commit for which comments were posted and force-push again. This will restore the previous commits.

  7. After getting an approval from one or more of UCX maintainers the PR can be merged.
    At this point, the author can squash all commits into one and force-push, to keep a clean git history. It's recommended to not rebase on master (unless required because of a merge conflict) so github could show that no files were changed.

More details here.