TDE Gitea Workspace - Revision history

Michele Calgaro: Updated TDE PR rebase and merge with pictures

2024-03-03T13:48:46Z

Updated TDE PR rebase and merge with pictures

Michele Calgaro: Updated with PR rebasing and merging. Screenshot not yet added.

2024-03-03T13:09:32Z

Updated with PR rebasing and merging. Screenshot not yet added.

Michele Calgaro: Minor fix to contributing new code section

2022-12-22T03:09:14Z

Minor fix to contributing new code section

Blu256: Small formatting improvements (mostly usage of syntax highlighting for shell commands)

2021-11-03T14:43:15Z

Small formatting improvements (mostly usage of syntax highlighting for shell commands)

Show changes

Michele Calgaro: Vompleted PR review section

2021-05-29T02:03:56Z

Vompleted PR review section

Michele Calgaro: More PR review steps

2021-05-29T01:52:23Z

More PR review steps

Michele Calgaro: More work on PR review

2021-05-29T01:40:22Z

More work on PR review

Michele Calgaro: Continued PR review section - still not finished

2021-05-25T02:33:47Z

Continued PR review section - still not finished

Michele Calgaro: first part of PR review section

2021-05-23T08:49:17Z

first part of PR review section

Michele Calgaro: Updated section "As a TDE developer"

2021-05-23T08:27:21Z

Updated section "As a TDE developer"

@@ Line 250: / Line 250: @@
 *:<span style="color:#ff0000">'''NOTE''': make sure each commit of the contributor has been properly signed-off with the '-s' flag, in accordance with the [https://developercertificate.org DCO]. Commits that have not been signed-off cannot be accepted and you need to ask the contributor to sign-off and resubmit the code.</span>
-* Once the PR is deemed good to be merged, make sure to rebase it against the latest commit of the main trunk.
+* Once the PR is deemed good to be merged, you can optionally rebase it against the latest commit of the main trunk, although it is now possible to do this using the TGW GUI interface (see a later step below).
 *:
 *:<span style="color:#ff0000">'''NOTE''': If the original commits from a contributor were GPG-signed, rebasing the branch against the latest commit of the main trunk would discard the contributor signature of those commits. In a situation like this one, it would be more appropriate to ask the original contributor to do the rebasing instead, so the commits remain GPG-signed by him/her.</span>
 <syntaxhighlight lang="shell-session">
@@ Line 269: / Line 268: @@
 * Check whether the PR needs to be rebased or not. To do this, you can look at the commit graph by navigating to the '''graph''' page of the original repository (for example for a PR in "tdebase", the "graph" page is "https://mirror.git.trinitydesktop.org/gitea/TDE/tdebase/graph".<br/>If the PR commits are directly on top of "master" branch, rebase is not needed and you can jump to the "Merge" step below.<br/>If the PR branched out from older commits, a rebase is required. If commits are GPG-signed, you will need to ask the PR author to rebase the PR to maintain their GPG signature. If the commits are not GPG-signed, you can rebase the PR using the TGW interface (see next step).
+* Rebase the PR as follow:
-* Rebase the PR. The TGW GUI presents a combobox offering different rebase modes.<br/>
+*:1. The TGW GUI presents a combobox offering different rebase modes.
-Choose '''Update branch by rebase''' and once the combobox closes, click on the button itself.<br/>
-Wait for the page to reload and for potential merge conflict checks to complete. Once the page shows that the PR can be merged, follow the instructions at the next step.<br/>
-You can double check that the PR has been correctly rebased by looking at the "graph" page as explained in the previous step.
-* Merge the PR from the TGW interface. You can choose to merge the commits as they are ('''Rebase then fast-forward''') or compress all commits into a single one ('''Create squash commit''').
 *:
-*:[[File:TGW-PR-merge1.jpg|650px|TGW PR merge 1]]<br>
+*:[[File:PR-update-by-rebase-menu.png|650px|TGW PR update and rebase menu]]
-* Make sure to check the '''Delete Branch''' checkbox, unless the PR has been tagged with the '''keep branch''' label. Then confirm the operation by clicking the green button.
 *:
+*:2. Choose '''Update branch by rebase''' and once the combobox closes, click on the button itself.
-*:[[File:TGW-PR-merge2.jpg|650px|TGW PR merge 2]]<br>
+*:
+*:[[File:PR-update-by-rebase-action.png|650px|TGW PR update and rebase action]]
+*:
+*:3. Wait for the page to reload and for potential merge conflict checks to complete. Once the page shows that the PR can be merged, follow the instructions at the next step.<br/>
+*:4. You can double check that the PR has been correctly rebased by looking at the "graph" page as explained in the previous step.
+* Merge the PR from the TGW interface as follow:
-* If you forgot to mark the "delete branch" check box, delete the PR branch, unless the PR has been tagged with the '''keep branch''' label.
+*:1. You can choose to merge the commits as they are ('''Rebase then fast-forward''') or compress all commits into a single one ('''Create squash commit''').
+*:
+*:[[File:PR-merge-menu.png|650px|TGW PR merge menu]]<br>
+*:
+*:2. Make sure to check the '''Delete Branch''' checkbox, unless the PR has been tagged with the '''keep branch''' label. Then confirm the operation by clicking the green button.
+*:
+*:[[File:PR-merge-action.png|650px|TGW PR merge action]]<br>
+*:
+*:3. If you forgot to mark the "Delete Branch" check box, delete the PR branch using the red button, unless the PR has been tagged with the '''keep branch''' label.
 *:
 *:[[File:TGW-PR-merge3.jpg|650px|TGW PR merge 3]]<br>

@@ Line 267: / Line 267: @@
 </syntaxhighlight>
+* Check whether the PR needs to be rebased or not. To do this, you can look at the commit graph by navigating to the '''graph''' page of the original repository (for example for a PR in "tdebase", the "graph" page is "https://mirror.git.trinitydesktop.org/gitea/TDE/tdebase/graph".<br/>If the PR commits are directly on top of "master" branch, rebase is not needed and you can jump to the "Merge" step below.<br/>If the PR branched out from older commits, a rebase is required. If commits are GPG-signed, you will need to ask the PR author to rebase the PR to maintain their GPG signature. If the commits are not GPG-signed, you can rebase the PR using the TGW interface (see next step).
-* Merge the PR from the TGW website. You can choose to merge the commits as they are ('''Rebase and Merge''') or compress all commits into a single one ('''Squash and Merge''').
+* Rebase the PR. The TGW GUI presents a combobox offering different rebase modes.<br/>
+Choose '''Update branch by rebase''' and once the combobox closes, click on the button itself.<br/>
+Wait for the page to reload and for potential merge conflict checks to complete. Once the page shows that the PR can be merged, follow the instructions at the next step.<br/>
+You can double check that the PR has been correctly rebased by looking at the "graph" page as explained in the previous step.
+* Merge the PR from the TGW interface. You can choose to merge the commits as they are ('''Rebase then fast-forward''') or compress all commits into a single one ('''Create squash commit''').
 *:
 *:[[File:TGW-PR-merge1.jpg|650px|TGW PR merge 1]]<br>
-* Confirm the operation by clicking the green button.
+* Make sure to check the '''Delete Branch''' checkbox, unless the PR has been tagged with the '''keep branch''' label. Then confirm the operation by clicking the green button.
 *:
 *:[[File:TGW-PR-merge2.jpg|650px|TGW PR merge 2]]<br>
-* Delete the PR branch, unless the PR has been tagged with the '''keep branch''' label.
+* If you forgot to mark the "delete branch" check box, delete the PR branch, unless the PR has been tagged with the '''keep branch''' label.
 *:
 *:[[File:TGW-PR-merge3.jpg|650px|TGW PR merge 3]]<br>

@@ Line 185: / Line 185: @@
 #:
 #:
-# From the '''pull from''' combobox, select the branch (4) that you had previously created and pushed.
+# From the '''pull from''' combobox, select the branch (4) that you had previously created and pushed, then click the '''New pull request''' button.
 #:
 #:[[File:TGW-PR-select-branch.jpg|800px|TGW PR select branch]]<br><br>

@@ Line 216: / Line 216: @@
 *:[[File:PR-request_reviewed.png|800px|TGW PR request reviewed]]<br/><br/>
+* After fixing eventual problems, the PR will mark some or all the comments as outdated and either the contributor or the reviewer can mark the conversation about individual comments as completed ('Resolve conversation' button (1) ). This will hide the old comment and highlight the fact the related problem has been addressed.
--- (section under development) --
+*:
+*:[[File:PR-request modified.png|800px|TGW PR request reviewed]]<br/><br/>
 =='''As a TDE developer'''==

@@ Line 203: / Line 203: @@
 * Repeat the previous two steps for all the comments you want to make.
+* Note that if you started a review, your comments will be marked as 'Pending' till you complete the review steps.
+*:
+*:[[File:PR-review-pending-comment.png|800px|TGW PR request pending comment]]<br/><br/>
 * If you started a review, you can now complete the process by clicking the 'Review' button (1) on top. This will open a text field where you can input further comments about the complete PR. Here it is good to provide some explanation about the reasons for approving a PR ('Approve' button (2) ) or for requesting more work on it ('Request changes' button (4) ). You could also just add a comment ('Comment' button (3) ) if you are still unsure whether the PR is good or not and you want to provide feedback to the contributor.
@@ Line 208: / Line 212: @@
 *:[[File:PR-review-submit.png|800px|TGW PR request submit]]<br/><br/>
+* The contributor will see the feedback and can now work on fixing up pending issues if there are any.
--- (Section still under development) --
+*:
+*:[[File:PR-request_reviewed.png|800px|TGW PR request reviewed]]<br/><br/>
+-- (section under development) --
 =='''As a TDE developer'''==

@@ Line 187: / Line 187: @@
 =='''<span id="ReviewPR"></span>To ask for and review PRs from other contributors'''==
 Sometimes contributors propose a PR and ask for feedback about it. Gitea allows to easily review the proposed changes and also approve the changes or request additional modifications.
-To ask for a PR to be reviewed by other people, please select the reviewer name in the 'Reviewers' field (you can add more than one reviewer). This indicates to those people that you would like your code to be checked by them.
+* To ask for a PR to be reviewed by other people, please select the reviewer name in the 'Reviewers' field (you can add more than one reviewer). This indicates to those people that you would like your code to be checked by them.
-#:
+*:
-#:[[File:PR-request_review.png|800px|TGW PR request review]]<br/><br/>
+*:[[File:PR-request_review.png|800px|TGW PR request review]]<br/><br/>
-#:
+* To review a PR, go to the 'Files changed' tab (1), search for the lines you want to comment about and click the '+' signed on the left (2). If you click and drag over multiple lines, you can place a comment for the entire selection (although it seems there is no visual feedback about the multi selection).
-#:
+*:
+*:[[File:PR-review-start-comment.png|800px|TGW PR request start comment]]<br/><br/>
 -- (Section still under development) --