-
Notifications
You must be signed in to change notification settings - Fork 206
Steps to a successful PR
When submitting a PR, please follow these steps:
-
We highly suggest you submit your change as a draft if you haven't finished your code.
-
The code meets "small CL" requirement and has a good quality.
-
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:
- Assume you named the
dataprep
repo as "origin" in your local git workspace. - run
git fetch origin
to get the newest code from dataprep repo. - run
git rebase develop
to update all your changes to the newest develop branch. - 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.
- Assume you named the
-
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. -
You wait until CI passes. If CI failed, change the code until CI passes and ensure RSR.
-
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.
-
You ensure RSR, and again you request the code review.
-
The reviewer approves your PR and he clicks the
merge
button. -
Congratulations! You successfully contribute to Dataprep and we really appreciate that!
-
[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 befix/<fix_name>
.