-
Notifications
You must be signed in to change notification settings - Fork 75
Guide to Raise a Pull Request (PR)
Yicong Huang edited this page Sep 14, 2023
·
6 revisions
- Create a branch with your name as a prefix and a brief description of the task, e.g.,
yicong-add-treemap-operator
. Please make sure the branch is under the Texera/texera repo, instead of your own fork, to make it easier for reviewers to test your branch. - Create a Pull Request on GitHub.
- Write a clear and meaningful title for the PR.
- Provide a detailed description of the PR, including
- the purpose of the PR,
- a brief description of the changes,
- possible technical design diagram,
- and also a gif/screenshot for demonstration purposes.
- Please avoid pushing sensitive information to the PR, including
- local configurations (e.g.,
python_udf.conf
); - sensitive information in code (e.g., password information, tokens);
- binary files from build.
- local configurations (e.g.,
- Add yourself as the assignee of the PR.
- Add a proper label to the PR, e.g.,
fix
,enhancement
, etc. - Request at least a reviewer and start the review process.
- Make sure your PR passes all CI tests (in GitHub Action).
- After being approved and passing all CI tests, fully test your PR locally before merging it.
- Finally, use the GitHub
Squash and merge
feature to merge the PR into the master branch.
If you opened a PR, but it is not ready for review yet, please mark the PR as a draft. You can later unmark it to resume the review process.