Skip to content

Steps to a successful PR

Weiyüen Wu edited this page Mar 26, 2020 · 10 revisions

When submitting a PR, please follow the following steps:

  1. You finished the code and ensure it has a good quality.
  2. You rebase the commits onto the newest develop branch, squash the unnecessary PR and reword the commit message, making sure it conforms to the coding rules and is informative as a release note (we generate release note directly from commit messages).
  3. You submit the PR and fill in the PR template carefully. If any UI changes are involved, include a screenshot in the PR comment to demo. If any issue are closed by this PR, add closes #<issue-id> in your PR text.
  4. You wait until CI passes. If CI failed, change the code until CI passes.
  5. 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.
  6. You rebase, squash and reword the commit, and again you request the code review.
  7. The reviewer approves your PR and he clicks the merge button.
  8. Congratulations! You successfully contribute to dataprep!
Clone this wiki locally