Skip to content

Steps to a successful PR

Weiyuan Wu edited this page Jun 15, 2020 · 10 revisions

When submitting a PR, please follow these steps:

  1. We highly suggest you submit your change as a draft if you haven't finished your code.

  2. The code meets "small CL" requirement and has a good quality.

  3. R(ebase)-S(quash)-R(eword): You rebase the commits onto the newest develop branch, squash the unnecessary commits and merge commits and reword the commit messages. You make sure the commit messages conform to the coding rules and are informative as release notes (we generate release notes directly from commit messages). Detailed steps:

    1. Assume you named the dataprep repo as "origin" in your local git workspace.
    2. run git fetch origin to get the newest code from dataprep repo.
    3. run git rebase develop to update all your changes to the newest develop branch.
    4. run git rebase -i $(git merge-base develop HEAD) to do Squash and Reword. See here if you don't know how to Squash and Reword.
  4. You create a PR and fill in the PR template carefully. If any UI changes are involved, a screenshot should also be included. If an issue is closed by this PR, add closes #<issue-id> in your PR text.

  5. You wait until CI passes. If CI failed, change the code until CI passes and ensure RSR.

  6. You request a code review from our team members. You get several comments later and change the code to resolve the comments. You also click the resolve button on the comments.

  7. You ensure RSR, and again you request the code review.

  8. The reviewer approves your PR and he clicks the merge button.

  9. Congratulations! You successfully contribute to Dataprep and we really appreciate that!

  10. [Internal Only] For internal contributors (those who create branches into dataprep repo), please keep your branch name following the git workflow convention. E.g. a feature branch should named as feat/<feature_name? and a fix branch should be fix/<fix_name>.