prpl/prplMesh
1
0
Fork 0
mirror of https://gitlab.com/prpl-foundation/prplmesh/prplMesh.git synced 2025-12-20 01:21:22 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

documentaion: CONTRIBUTING.md workflow adjustments

Browse Source 
Update workflow to better describe how to work with fixup commits, when
to do rebase-force-push during review, etc.

Signed-off-by: Tomer Eliyahu <tomer.b.eliyahu@intel.com>
This commit is contained in:
Tomer Eliyahu
2019-06-25 21:44:51 +03:00
parent f27b527b2b
commit 571ae2d18a
1 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
CONTRIBUTING.md
View File

@@ -160,13 +160,19 @@ This section describes the full workflow.
For smaller contributions, you may take shortcuts.
The workflow is explained in detail below. In summary, it consists of these steps.
1. Create a branch
2. Create a draft pull request
3. Make the changes, commit with amend and rebase
4. Push regularly
5. Clean up the commits, push, and set pull request to "Ready for review"
6. Review is done.
7. Address review comments in additional fixup commits.
6. Review starts - reviewer "Requests changes"
7. Author addresses review comments in additional fixup commits.
* If no more fixes are needed
* Author rebases with `git rebase -i --autosquash master` to clean up the pull request.
* If more fixes are needed (suggested by reviewers or by the author himself)
* Author does rebase-force-push to squash fixup commits and asks for a followup review (this makes the next review iterations simpler)
8. Review is approved by maintainers.
9. Use `git rebase -i --autosquash master` to clean up the pull request.
10. Pull request is merged by maintainers.