From a0178a4b68c53faf9947edcbe2192a2b67180d66 Mon Sep 17 00:00:00 2001 From: Mahesh Binzer-Panchal Date: Tue, 12 Mar 2024 13:11:28 +0100 Subject: [PATCH 01/26] Update gh-collaboration.qmd --- github/gh-collaboration.qmd | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/github/gh-collaboration.qmd b/github/gh-collaboration.qmd index e69de29..1acaac6 100644 --- a/github/gh-collaboration.qmd +++ b/github/gh-collaboration.qmd @@ -0,0 +1,15 @@ +# How to collaborate on Github + +## Making a branch + +## Making changes + +## Making a draft pull request + +## Making a ready for review pull request + +## Code review + +## Making changes + +## Merging From d3a10c7e6eeb5598f2b76d747e0a20018287ed71 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Miguel=20=C3=81ngel=20Redondo?= <105673050+RedondoMA@users.noreply.github.com> Date: Tue, 12 Mar 2024 13:53:57 +0100 Subject: [PATCH 02/26] Update gh-collaboration.qmd Modifying 'making a ready for review pull request' --- github/gh-collaboration.qmd | 2 ++ 1 file changed, 2 insertions(+) diff --git a/github/gh-collaboration.qmd b/github/gh-collaboration.qmd index 1acaac6..51d6c8a 100644 --- a/github/gh-collaboration.qmd +++ b/github/gh-collaboration.qmd @@ -8,6 +8,8 @@ ## Making a ready for review pull request +After creating a draft pull request, you should invite a reviewer that has been assigned to your caption. The reviewer will go through the changes that you made on the original file and suggest changes, for example, clicking on the '+' icon. + ## Code review ## Making changes From b42903ec79bda033a8e104c14fd72030e5cd7726 Mon Sep 17 00:00:00 2001 From: Cormac Kinsella <27350062+CormacKinsella@users.noreply.github.com> Date: Tue, 12 Mar 2024 14:12:09 +0100 Subject: [PATCH 03/26] Update gh-collaboration.qmd --- github/gh-collaboration.qmd | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/github/gh-collaboration.qmd b/github/gh-collaboration.qmd index 1acaac6..f31ed0e 100644 --- a/github/gh-collaboration.qmd +++ b/github/gh-collaboration.qmd @@ -4,6 +4,13 @@ ## Making changes +- Fork the whole target repository to your own account, by selecting "Fork" -> include all the branches (i.e., untick "Copy the main branch only") -> "Create fork". +- On your fork, first go into the correct branch for making edits by clicking the branch drop down menu and selecting it. +- To edit a file that already exists, navigate to it then click the pencil symbol to go into edit mode. +- If instead you need to make a new file in the branch, click the "Add file" drop down -> "create new file". Give the file a meaningful name and extension. When naming files you can make new directories by adding forward slashes in the title, e.g., "github/myfile.qmd" will create the folder github also. +- Add the file contents in edit mode. +- When finished, click "Commit changes..." + ## Making a draft pull request ## Making a ready for review pull request From 2ea5428f15bb362d9e712cbe6eaa7f564c898c69 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Miguel=20=C3=81ngel=20Redondo?= <105673050+RedondoMA@users.noreply.github.com> Date: Tue, 12 Mar 2024 14:49:29 +0100 Subject: [PATCH 04/26] Update gh-collaboration.qmd --- github/gh-collaboration.qmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/github/gh-collaboration.qmd b/github/gh-collaboration.qmd index 51d6c8a..6294d65 100644 --- a/github/gh-collaboration.qmd +++ b/github/gh-collaboration.qmd @@ -8,7 +8,7 @@ ## Making a ready for review pull request -After creating a draft pull request, you should invite a reviewer that has been assigned to your caption. The reviewer will go through the changes that you made on the original file and suggest changes, for example, clicking on the '+' icon. +After commiting the changes to the file, the user creates a draft pull request by clicking in pull requests tab, create a pull request, clicking in the dropdown next to create pull request and clicking in create draft pull request. On the right side panel, you should invite a reviewer that has been assigned to your caption. The reviewer will go through the changes that you made on the original file and suggest changes, for example, clicking on the '+' icon. ## Code review From 242f862d12f9340385d2fef0d72f24c1e7860bb3 Mon Sep 17 00:00:00 2001 From: Per Unneberg Date: Tue, 12 Mar 2024 16:32:52 +0100 Subject: [PATCH 05/26] Update gh-collaboration.qmd - draft pull request --- github/gh-collaboration.qmd | 2 ++ 1 file changed, 2 insertions(+) diff --git a/github/gh-collaboration.qmd b/github/gh-collaboration.qmd index f1f9208..8f0dcc3 100644 --- a/github/gh-collaboration.qmd +++ b/github/gh-collaboration.qmd @@ -13,6 +13,8 @@ ## Making a draft pull request +After making and committing changes as described above, + ## Making a ready for review pull request After commiting the changes to the file, the user creates a draft pull request by clicking in pull requests tab, create a pull request, clicking in the dropdown next to create pull request and clicking in create draft pull request. On the right side panel, you should invite a reviewer that has been assigned to your caption. The reviewer will go through the changes that you made on the original file and suggest changes, for example, clicking on the '+' icon. From 53ba1f1d5c7a04b0379e13d77bd16149a111bd01 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Miguel=20=C3=81ngel=20Redondo?= <105673050+RedondoMA@users.noreply.github.com> Date: Tue, 12 Mar 2024 16:33:14 +0100 Subject: [PATCH 06/26] Update gh-collaboration.qmd added in bullet point format (to keep practicing draft pull requests ;) --- github/gh-collaboration.qmd | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/github/gh-collaboration.qmd b/github/gh-collaboration.qmd index 6294d65..36023f8 100644 --- a/github/gh-collaboration.qmd +++ b/github/gh-collaboration.qmd @@ -8,7 +8,9 @@ ## Making a ready for review pull request -After commiting the changes to the file, the user creates a draft pull request by clicking in pull requests tab, create a pull request, clicking in the dropdown next to create pull request and clicking in create draft pull request. On the right side panel, you should invite a reviewer that has been assigned to your caption. The reviewer will go through the changes that you made on the original file and suggest changes, for example, clicking on the '+' icon. +-After commiting the changes to the file, the user creates a draft pull request by clicking in pull requests tab->create a pull request ->clicking in the dropdown next to create pull request and clicking in create draft pull request. +-On the right side panel, you should invite a reviewer that has been assigned to your caption. +-The reviewer will go through the changes that you made on the original file and suggest changes, for example, clicking on the '+' icon. ## Code review From 7be9cabff242797df9a5aba1c9b61261f8d96eab Mon Sep 17 00:00:00 2001 From: Per Unneberg Date: Tue, 12 Mar 2024 16:39:44 +0100 Subject: [PATCH 07/26] Update gh-collaboration.qmd - draft pull request --- github/gh-collaboration.qmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/github/gh-collaboration.qmd b/github/gh-collaboration.qmd index 8f0dcc3..1f3fc7a 100644 --- a/github/gh-collaboration.qmd +++ b/github/gh-collaboration.qmd @@ -13,7 +13,7 @@ ## Making a draft pull request -After making and committing changes as described above, +After making and committing changes as described above, navigate to the Pull requests tab. Click "New pull request" which will produce a "Comparing changes" page with four dropdown list. The leftmost lists the target repository of the pull request and should be set to NBISweden/Training-Tech-shorts, followed by the target branch. The two rightmost dropdown lists refer to the pull request source and should point to your repository and, importantly, the branch that you are editing (and make sure it matches the target branch!). Once done, click "Create pull request" which will generate a pull request page where you can make comments on your PR. Finally, change the green dropdown button "Create pull request" to "Create draft pull request" and you're done! ## Making a ready for review pull request From 22889a2639bd9739deafaf592ccb7714439351ac Mon Sep 17 00:00:00 2001 From: Per Unneberg Date: Tue, 12 Mar 2024 16:41:48 +0100 Subject: [PATCH 08/26] Update gh-collaboration.qmd - draft pull request Fix typos. --- github/gh-collaboration.qmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/github/gh-collaboration.qmd b/github/gh-collaboration.qmd index 1f3fc7a..e493ff3 100644 --- a/github/gh-collaboration.qmd +++ b/github/gh-collaboration.qmd @@ -13,7 +13,7 @@ ## Making a draft pull request -After making and committing changes as described above, navigate to the Pull requests tab. Click "New pull request" which will produce a "Comparing changes" page with four dropdown list. The leftmost lists the target repository of the pull request and should be set to NBISweden/Training-Tech-shorts, followed by the target branch. The two rightmost dropdown lists refer to the pull request source and should point to your repository and, importantly, the branch that you are editing (and make sure it matches the target branch!). Once done, click "Create pull request" which will generate a pull request page where you can make comments on your PR. Finally, change the green dropdown button "Create pull request" to "Create draft pull request" and you're done! +After making and committing changes as described above, navigate to the Pull requests tab. Click "New pull request" which will produce a "Comparing changes" page with four dropdown lists. The leftmost two dropdown lists refer to the target repository of the pull request and should be set to NBISweden/Training-Tech-shorts, followed by the target branch. The two rightmost dropdown lists refer to the pull request source and should point to your repository and, importantly, the branch that you are editing (and make sure it matches the target branch!). Once done, click "Create pull request" which will generate a pull request page where you can make comments on your PR. Finally, change the green dropdown button "Create pull request" to "Create draft pull request" and you're done! ## Making a ready for review pull request From 055f7c3b676e0e5a9f9ede5ed513d8b6d83cda6a Mon Sep 17 00:00:00 2001 From: Tomas Larsson Date: Tue, 12 Mar 2024 17:11:10 +0100 Subject: [PATCH 09/26] Update gh-collaboration.qmd --- github/gh-collaboration.qmd | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/github/gh-collaboration.qmd b/github/gh-collaboration.qmd index fcee875..46e5995 100644 --- a/github/gh-collaboration.qmd +++ b/github/gh-collaboration.qmd @@ -1,6 +1,12 @@ # How to collaborate on Github ## Making a branch +- On the main page of the repository click on the branch dropdown menue. +- View all branches +- Click New branch, give it a name and select the branch source. +- Click create branch + +You can also make a branch by clicking on the dropdown menue and give an unique name in the "Find or create branch..." field followed by clicking Create branch. ## Making changes From 7a3982536c66e9c64d3929487be7880031a36861 Mon Sep 17 00:00:00 2001 From: Verena Kutschera Date: Wed, 13 Mar 2024 13:28:58 +0100 Subject: [PATCH 10/26] Update gh-collaboration.qmd - merging --- github/gh-collaboration.qmd | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/github/gh-collaboration.qmd b/github/gh-collaboration.qmd index fcee875..b55ed25 100644 --- a/github/gh-collaboration.qmd +++ b/github/gh-collaboration.qmd @@ -24,3 +24,7 @@ ## Making changes ## Merging + +- Once the changes are approved by the reviewer(s), and there are no conflicts of your branch with the base branch, you can merge the changes you've made on your branch into the main branch of the target repository. +- To do that, you click on "Pull requests" in the header line of the target repository, and select your pull request. Here you click on "Merge pull request" to perform the merging. +- A github workflow is planned that will automatically publish the updated text on the website. From 86864d4e531535f849581ea221d4837e463edd2a Mon Sep 17 00:00:00 2001 From: Per Unneberg Date: Wed, 13 Mar 2024 13:41:57 +0100 Subject: [PATCH 11/26] Add info on forks --- github/gh-collaboration.qmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/github/gh-collaboration.qmd b/github/gh-collaboration.qmd index 08f3b30..6ab5aa3 100644 --- a/github/gh-collaboration.qmd +++ b/github/gh-collaboration.qmd @@ -13,7 +13,7 @@ ## Making a draft pull request -After making and committing changes as described above, navigate to the Pull requests tab. Click "New pull request" which will produce a "Comparing changes" page with four dropdown lists. The leftmost two dropdown lists refer to the target repository of the pull request and should be set to NBISweden/Training-Tech-shorts, followed by the target branch. The two rightmost dropdown lists refer to the pull request source and should point to your repository and, importantly, the branch that you are editing (and make sure it matches the target branch!). Once done, click "Create pull request" which will generate a pull request page where you can make comments on your PR. Finally, change the green dropdown button "Create pull request" to "Create draft pull request" and you're done! +After making and committing changes as described above, navigate to the Pull requests tab. Click "New pull request" which will produce a "Comparing changes" page with four dropdown lists. The leftmost two dropdown lists refer to the target repository of the pull request and should be set to NBISweden/Training-Tech-shorts, followed by the target branch. The two rightmost dropdown lists refer to the pull request source and should point to your repository and, importantly, the branch that you are editing (and make sure it matches the target branch!). By default, only the branches of the target repository are shown. To find the updated branch from the forked repository, one has to click on "If you need to, you can also compare across forks.". Once done, click "Create pull request" which will generate a pull request page where you can make comments on your PR. Finally, change the green dropdown button "Create pull request" to "Create draft pull request" and you're done! ## Making a ready for review pull request From 63804bfedbe59d56e6b7b22316b3bb4a83df02bd Mon Sep 17 00:00:00 2001 From: Martin Pippel Date: Fri, 15 Mar 2024 13:24:15 +0100 Subject: [PATCH 12/26] Update gh-collaboration.qmd - add Code review block (v1) --- github/gh-collaboration.qmd | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/github/gh-collaboration.qmd b/github/gh-collaboration.qmd index fcee875..abe8cbd 100644 --- a/github/gh-collaboration.qmd +++ b/github/gh-collaboration.qmd @@ -21,6 +21,20 @@ ## Code review +- navigate to the top menu and click on `Pull requests` +- by default all open pull requests are listed, you can further filter down the list. e.g. via clicking on `Reviews` and afterwards select `Awaiting review from you` in the drop down menu. This show then only pull requests where you are tagged as reviewer. +- click on a pull request of your choice +- the following window has 4 tabs: + * Conversation: gives an overview about the PR + * Commits: list all commuit of the PR + * Check: + * Files changed: lists all files which were modified +- click on the `Files changed` tab and go through the files and changes + * you can comment in a line by hovering over a line and click on the plus symbol + * in case you want to comment on a block of lines: click and hold at the line number of the start of the block and relase at the end of the block. Now you need to click on the plus symbol of the last line, in order to comment on the full block of lines + * when done with the review click on `Finish your review` button on the top right corner of the page: + - you can comment on your review and choose one of the following options `Comment`, `Approve`, `Request changes`. Select the approprate option and click on `Submit review`. + ## Making changes ## Merging From 4985e49afadda8b104c259f1748bd8b30a8ee789 Mon Sep 17 00:00:00 2001 From: Martin Pippel Date: Fri, 15 Mar 2024 13:28:21 +0100 Subject: [PATCH 13/26] Update gh-collaboration.qmd - add Code review block (v2 fix typos) --- github/gh-collaboration.qmd | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/github/gh-collaboration.qmd b/github/gh-collaboration.qmd index abe8cbd..4f48f62 100644 --- a/github/gh-collaboration.qmd +++ b/github/gh-collaboration.qmd @@ -22,17 +22,17 @@ ## Code review - navigate to the top menu and click on `Pull requests` -- by default all open pull requests are listed, you can further filter down the list. e.g. via clicking on `Reviews` and afterwards select `Awaiting review from you` in the drop down menu. This show then only pull requests where you are tagged as reviewer. +- by default all open pull requests are listed, you can further filter down the list. e.g. via clicking on `Reviews` and afterwards select `Awaiting review from you` in the drop down menu. This shows then only PRs where you are tagged as reviewer. - click on a pull request of your choice - the following window has 4 tabs: * Conversation: gives an overview about the PR - * Commits: list all commuit of the PR + * Commits: list all commits of the PR * Check: * Files changed: lists all files which were modified - click on the `Files changed` tab and go through the files and changes - * you can comment in a line by hovering over a line and click on the plus symbol - * in case you want to comment on a block of lines: click and hold at the line number of the start of the block and relase at the end of the block. Now you need to click on the plus symbol of the last line, in order to comment on the full block of lines - * when done with the review click on `Finish your review` button on the top right corner of the page: + * you can comment on a line by hovering over a line and click on the plus symbol + * in case you want to comment on a block of lines: click and hold at the line number of the start of the block and release at the end of the block. Now you need to click on the plus symbol of the last line, in order to comment on the full block of lines + * when done with the review click on the `Finish your review` button on the top right corner of the page: - you can comment on your review and choose one of the following options `Comment`, `Approve`, `Request changes`. Select the approprate option and click on `Submit review`. ## Making changes From 0f6289a13b0f5f743929d3e5ae8bde63f9caee4f Mon Sep 17 00:00:00 2001 From: Martin Pippel Date: Fri, 15 Mar 2024 15:53:28 +0100 Subject: [PATCH 14/26] Update gh-collaboration.qmd - add Code review block (v2 add comment pending info) --- github/gh-collaboration.qmd | 1 + 1 file changed, 1 insertion(+) diff --git a/github/gh-collaboration.qmd b/github/gh-collaboration.qmd index 4f48f62..715acbe 100644 --- a/github/gh-collaboration.qmd +++ b/github/gh-collaboration.qmd @@ -32,6 +32,7 @@ - click on the `Files changed` tab and go through the files and changes * you can comment on a line by hovering over a line and click on the plus symbol * in case you want to comment on a block of lines: click and hold at the line number of the start of the block and release at the end of the block. Now you need to click on the plus symbol of the last line, in order to comment on the full block of lines + * those comments are marked as pending and are not visible to anybody until you click `Finish your review` * when done with the review click on the `Finish your review` button on the top right corner of the page: - you can comment on your review and choose one of the following options `Comment`, `Approve`, `Request changes`. Select the approprate option and click on `Submit review`. From a4b1e0731345735aca3a03cec3b49cf48df20611 Mon Sep 17 00:00:00 2001 From: Martin Pippel Date: Fri, 15 Mar 2024 17:21:34 +0100 Subject: [PATCH 15/26] Update gh-collaboration.qmd - add Code review block (v3) differentiate review options: Add-single-comment and Start-a-review --- github/gh-collaboration.qmd | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/github/gh-collaboration.qmd b/github/gh-collaboration.qmd index 715acbe..430a6c8 100644 --- a/github/gh-collaboration.qmd +++ b/github/gh-collaboration.qmd @@ -32,9 +32,12 @@ - click on the `Files changed` tab and go through the files and changes * you can comment on a line by hovering over a line and click on the plus symbol * in case you want to comment on a block of lines: click and hold at the line number of the start of the block and release at the end of the block. Now you need to click on the plus symbol of the last line, in order to comment on the full block of lines - * those comments are marked as pending and are not visible to anybody until you click `Finish your review` - * when done with the review click on the `Finish your review` button on the top right corner of the page: - - you can comment on your review and choose one of the following options `Comment`, `Approve`, `Request changes`. Select the approprate option and click on `Submit review`. + * afterwards you can either: + a) click on the `Add single comment` button which makes your comment or suggestion immediately visible + OR + b) click on the `Start a review` button, which keeps your comment or suggestion in a pending state (unvisible to anybody). But this give you the chance to add further comments and suggestions. + * when done with the full review click on the `Finish your review` button on the top right corner of the page: + - you can comment on your review and choose one of the following options `Comment`, `Approve`, `Request changes`. Select the approprate option and click on `Submit review`. ## Making changes From c0b95730cce762cc4c795c4320ab27643fbb8589 Mon Sep 17 00:00:00 2001 From: Martin Pippel Date: Mon, 18 Mar 2024 08:19:40 +0100 Subject: [PATCH 16/26] Update github/gh-collaboration.qmd - add Code review block - accept suggestions Co-authored-by: Mahesh Binzer-Panchal --- github/gh-collaboration.qmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/github/gh-collaboration.qmd b/github/gh-collaboration.qmd index 430a6c8..8a0b0b9 100644 --- a/github/gh-collaboration.qmd +++ b/github/gh-collaboration.qmd @@ -35,7 +35,7 @@ * afterwards you can either: a) click on the `Add single comment` button which makes your comment or suggestion immediately visible OR - b) click on the `Start a review` button, which keeps your comment or suggestion in a pending state (unvisible to anybody). But this give you the chance to add further comments and suggestions. + b) click on the `Start a review` button, which keeps your comment or suggestion in a pending state (invisible to anybody). This gives you the chance to add further comments and suggestions. * when done with the full review click on the `Finish your review` button on the top right corner of the page: - you can comment on your review and choose one of the following options `Comment`, `Approve`, `Request changes`. Select the approprate option and click on `Submit review`. From 33c2d0f40aff46064797e76854811974e09efc6b Mon Sep 17 00:00:00 2001 From: Tomas Larsson Date: Tue, 19 Mar 2024 14:54:29 +0100 Subject: [PATCH 17/26] Update github/gh-collaboration.qmd Co-authored-by: Mahesh Binzer-Panchal --- github/gh-collaboration.qmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/github/gh-collaboration.qmd b/github/gh-collaboration.qmd index 46e5995..24a8d07 100644 --- a/github/gh-collaboration.qmd +++ b/github/gh-collaboration.qmd @@ -1,7 +1,7 @@ # How to collaborate on Github ## Making a branch -- On the main page of the repository click on the branch dropdown menue. +- On the main page of the repository click on the branch dropdown menu. - View all branches - Click New branch, give it a name and select the branch source. - Click create branch From 84936c6a06adef43b7c84733a5b8de697fbb6f07 Mon Sep 17 00:00:00 2001 From: Tomas Larsson Date: Tue, 26 Mar 2024 12:13:46 +0100 Subject: [PATCH 18/26] Update github/gh-collaboration.qmd Co-authored-by: Mahesh Binzer-Panchal --- github/gh-collaboration.qmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/github/gh-collaboration.qmd b/github/gh-collaboration.qmd index 24a8d07..49984b8 100644 --- a/github/gh-collaboration.qmd +++ b/github/gh-collaboration.qmd @@ -6,7 +6,7 @@ - Click New branch, give it a name and select the branch source. - Click create branch -You can also make a branch by clicking on the dropdown menue and give an unique name in the "Find or create branch..." field followed by clicking Create branch. +You can also make a branch by clicking on the drop-down menu and give an unique name in the "Find or create branch..." field followed by clicking Create branch. ## Making changes From 803604f8dd0bedf760c8697e65015d980154c415 Mon Sep 17 00:00:00 2001 From: Verena Kutschera Date: Wed, 27 Mar 2024 11:41:06 +0100 Subject: [PATCH 19/26] Clarify that teacher merges the pull request --- github/gh-collaboration.qmd | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/github/gh-collaboration.qmd b/github/gh-collaboration.qmd index b55ed25..400e6ac 100644 --- a/github/gh-collaboration.qmd +++ b/github/gh-collaboration.qmd @@ -23,8 +23,6 @@ ## Making changes -## Merging +## Teacher merges the pull request -- Once the changes are approved by the reviewer(s), and there are no conflicts of your branch with the base branch, you can merge the changes you've made on your branch into the main branch of the target repository. -- To do that, you click on "Pull requests" in the header line of the target repository, and select your pull request. Here you click on "Merge pull request" to perform the merging. -- A github workflow is planned that will automatically publish the updated text on the website. +- Once both teacher and learner are satisfied with the updates, the teacher merges the pull request. From 36688bd4268a9d9ac1097e2da861bf66399e8ac4 Mon Sep 17 00:00:00 2001 From: Verena Kutschera Date: Wed, 27 Mar 2024 14:05:13 +0100 Subject: [PATCH 20/26] Clarify that the teacher has a few things to merge --- github/gh-collaboration.qmd | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/github/gh-collaboration.qmd b/github/gh-collaboration.qmd index 400e6ac..1eac27a 100644 --- a/github/gh-collaboration.qmd +++ b/github/gh-collaboration.qmd @@ -23,6 +23,7 @@ ## Making changes -## Teacher merges the pull request +## Teacher merges pull requests -- Once both teacher and learner are satisfied with the updates, the teacher merges the pull request. +- Once both teacher and learner are satisfied with the updates, the teacher merges the learner's pull request into their lesson branch. +- Once the teacher has updated their lesson branch with the input from all learners, the teacher merges the lesson branch into the main branch. From 02869901eb663a55b25e5e4a368aef644571cf73 Mon Sep 17 00:00:00 2001 From: Per Unneberg Date: Tue, 2 Apr 2024 13:03:55 +0200 Subject: [PATCH 21/26] Update github/gh-collaboration.qmd Co-authored-by: Mahesh Binzer-Panchal --- github/gh-collaboration.qmd | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/github/gh-collaboration.qmd b/github/gh-collaboration.qmd index 6ab5aa3..f8c39f1 100644 --- a/github/gh-collaboration.qmd +++ b/github/gh-collaboration.qmd @@ -13,7 +13,8 @@ ## Making a draft pull request -After making and committing changes as described above, navigate to the Pull requests tab. Click "New pull request" which will produce a "Comparing changes" page with four dropdown lists. The leftmost two dropdown lists refer to the target repository of the pull request and should be set to NBISweden/Training-Tech-shorts, followed by the target branch. The two rightmost dropdown lists refer to the pull request source and should point to your repository and, importantly, the branch that you are editing (and make sure it matches the target branch!). By default, only the branches of the target repository are shown. To find the updated branch from the forked repository, one has to click on "If you need to, you can also compare across forks.". Once done, click "Create pull request" which will generate a pull request page where you can make comments on your PR. Finally, change the green dropdown button "Create pull request" to "Create draft pull request" and you're done! +After making and committing changes as described above, navigate to the Pull requests tab. Click "New pull request" which will produce a "Comparing changes" page with four drop-down lists. The leftmost two drop-down lists refer to the target repository of the pull request and should be set to NBISweden/Training-Tech-shorts, followed by the target branch. The two rightmost drop-down lists refer to the pull request source and should point to your repository and, importantly, the branch that you are editing (and make sure it matches the target branch!). By default, only the branches of the target repository are shown. To find the updated branch from the forked repository, one has to click on "If you need to, you can also compare across forks.". Once done, click "Create pull request" which will generate a pull request page where your review partner can make comments on your PR. Finally, change the green drop-down button "Create pull request" to "Create draft pull request" and you're done! + ## Making a ready for review pull request From dea3f6b8aee74d171bb1e316c176a10b7887a36a Mon Sep 17 00:00:00 2001 From: Tomas Larsson Date: Mon, 15 Apr 2024 17:16:53 +0200 Subject: [PATCH 22/26] Update gh-collaboration.qmd Clarified the text --- github/gh-collaboration.qmd | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/github/gh-collaboration.qmd b/github/gh-collaboration.qmd index 49984b8..2504752 100644 --- a/github/gh-collaboration.qmd +++ b/github/gh-collaboration.qmd @@ -1,12 +1,13 @@ # How to collaborate on Github ## Making a branch -- On the main page of the repository click on the branch dropdown menu. -- View all branches +- On the main page of the repository go to the file tree view on the left and click on the branch dropdown menu. +- Click on view all branches - Click New branch, give it a name and select the branch source. -- Click create branch +- Finally, click create branch -You can also make a branch by clicking on the drop-down menu and give an unique name in the "Find or create branch..." field followed by clicking Create branch. +You also have the possibility to directly make a branch by clicking on the drop-down menu and give a unique name in the "Find or create branch..." field, followed by clicking Create branch. +This will give the exact same result as the steps above. ## Making changes From 57d65baade1b929d1294d1ab81dc91454a644ca1 Mon Sep 17 00:00:00 2001 From: Per Unneberg Date: Tue, 16 Apr 2024 14:18:54 +0200 Subject: [PATCH 23/26] Change text related to creation of draft pull request Change drop-down button to "Create draft pull request" and then request review from reviewer. --- github/gh-collaboration.qmd | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/github/gh-collaboration.qmd b/github/gh-collaboration.qmd index c4197b4..5b30bb8 100644 --- a/github/gh-collaboration.qmd +++ b/github/gh-collaboration.qmd @@ -13,8 +13,20 @@ ## Making a draft pull request -After making and committing changes as described above, navigate to the Pull requests tab. Click "New pull request" which will produce a "Comparing changes" page with four drop-down lists. The leftmost two drop-down lists refer to the target repository of the pull request and should be set to NBISweden/Training-Tech-shorts, followed by the target branch. The two rightmost drop-down lists refer to the pull request source and should point to your repository and, importantly, the branch that you are editing (and make sure it matches the target branch!). By default, only the branches of the target repository are shown. To find the updated branch from the forked repository, one has to click on "If you need to, you can also compare across forks.". Once done, click "Create pull request" which will generate a pull request page where your review partner can make comments on your PR. Finally, change the green drop-down button "Create pull request" to "Create draft pull request" and you're done! - +After making and committing changes as described above, navigate to +the Pull requests tab. Click "New pull request" which will produce a +"Comparing changes" page with four drop-down lists. The leftmost two +drop-down lists refer to the target repository of the pull request and +should be set to NBISweden/Training-Tech-shorts, followed by the +target branch. The two rightmost drop-down lists refer to the pull +request source and should point to your repository and, importantly, +the branch that you are editing (and make sure it matches the target +branch!). By default, only the branches of the target repository are +shown. To find the updated branch from the forked repository, one has +to click on "If you need to, you can also compare across forks.". Once +done, change the green drop-down button "Create pull request" to +"Create draft pull request". This will generate a draft pull request +page where your review partner can make comments on your PR. ## Making a ready for review pull request From cd19e1629271a439df23ce99ae0e4c0796541688 Mon Sep 17 00:00:00 2001 From: Tomas Larsson Date: Wed, 17 Apr 2024 11:32:24 +0200 Subject: [PATCH 24/26] Update gh-collaboration.qmd Add link to step-by-step guide --- github/gh-collaboration.qmd | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/github/gh-collaboration.qmd b/github/gh-collaboration.qmd index 2504752..cfa6352 100644 --- a/github/gh-collaboration.qmd +++ b/github/gh-collaboration.qmd @@ -7,7 +7,10 @@ - Finally, click create branch You also have the possibility to directly make a branch by clicking on the drop-down menu and give a unique name in the "Find or create branch..." field, followed by clicking Create branch. -This will give the exact same result as the steps above. +This will give the exact same result as the steps above. + +This short description might be confusing since there are more than one way of doing this. +A step-by-step guide with pictures is available [here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository) ## Making changes From 85b1e70ba9e290811b7e6fa9ff2458f461e723c9 Mon Sep 17 00:00:00 2001 From: Tomas Larsson Date: Wed, 17 Apr 2024 11:32:46 +0200 Subject: [PATCH 25/26] Update gh-collaboration.qmd --- github/gh-collaboration.qmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/github/gh-collaboration.qmd b/github/gh-collaboration.qmd index cfa6352..2fb70d5 100644 --- a/github/gh-collaboration.qmd +++ b/github/gh-collaboration.qmd @@ -10,7 +10,7 @@ You also have the possibility to directly make a branch by clicking on the drop- This will give the exact same result as the steps above. This short description might be confusing since there are more than one way of doing this. -A step-by-step guide with pictures is available [here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository) +A step-by-step guide with pictures is available here (https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository) ## Making changes From bc97109c344e932226c8902f570bb0682438bbba Mon Sep 17 00:00:00 2001 From: Mahesh Binzer-Panchal Date: Wed, 17 Apr 2024 13:29:12 +0000 Subject: [PATCH 26/26] Reorder section and fix syntax --- github/gh-collaboration.qmd | 38 +++++++++++++++++++------------------ 1 file changed, 20 insertions(+), 18 deletions(-) diff --git a/github/gh-collaboration.qmd b/github/gh-collaboration.qmd index e641ca4..a924e9d 100644 --- a/github/gh-collaboration.qmd +++ b/github/gh-collaboration.qmd @@ -1,6 +1,10 @@ # How to collaborate on Github -## Making a branch +This section is a guide describing one method of collaborating on Github. We focus on +the framework that we use to make reference material for future us and others new to the team. + +## Making a branch (Teacher) + - On the main page of the repository go to the file tree view on the left and click on the branch dropdown menu. - Click on view all branches - Click New branch, give it a name and select the branch source. @@ -12,7 +16,7 @@ This will give the exact same result as the steps above. This short description might be confusing since there are more than one way of doing this. A step-by-step guide with pictures is available here (https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository) -## Making changes +## Making changes (Learner) - Fork the whole target repository to your own account, by selecting "Fork" -> include all the branches (i.e., untick "Copy the main branch only") -> "Create fork". - On your fork, first go into the correct branch for making edits by clicking the branch drop down menu and selecting it. @@ -21,7 +25,7 @@ A step-by-step guide with pictures is available here (https://docs.github.com/en - Add the file contents in edit mode. - When finished, click "Commit changes..." -## Making a draft pull request +## Making a draft pull request (Learner) After making and committing changes as described above, navigate to the Pull requests tab. Click "New pull request" which will produce a @@ -38,13 +42,7 @@ done, change the green drop-down button "Create pull request" to "Create draft pull request". This will generate a draft pull request page where your review partner can make comments on your PR. -## Making a ready for review pull request - --After commiting the changes to the file, the user creates a draft pull request by clicking in pull requests tab->create a pull request ->clicking in the dropdown next to create pull request and clicking in create draft pull request. --On the right side panel, you should invite a reviewer that has been assigned to your caption. --The reviewer will go through the changes that you made on the original file and suggest changes, for example, clicking on the '+' icon. - -## Code review +## Code review (Review partner) - navigate to the top menu and click on `Pull requests` - by default all open pull requests are listed, you can further filter down the list. e.g. via clicking on `Reviews` and afterwards select `Awaiting review from you` in the drop down menu. This shows then only PRs where you are tagged as reviewer. @@ -58,15 +56,19 @@ page where your review partner can make comments on your PR. * you can comment on a line by hovering over a line and click on the plus symbol * in case you want to comment on a block of lines: click and hold at the line number of the start of the block and release at the end of the block. Now you need to click on the plus symbol of the last line, in order to comment on the full block of lines * afterwards you can either: - a) click on the `Add single comment` button which makes your comment or suggestion immediately visible - OR - b) click on the `Start a review` button, which keeps your comment or suggestion in a pending state (invisible to anybody). This gives you the chance to add further comments and suggestions. - * when done with the full review click on the `Finish your review` button on the top right corner of the page: - - you can comment on your review and choose one of the following options `Comment`, `Approve`, `Request changes`. Select the approprate option and click on `Submit review`. + a) click on the `Add single comment` button which makes your comment or suggestion immediately visible + OR + b) click on the `Start a review` button, which keeps your comment or suggestion in a pending state (invisible to anybody). This gives you the chance to add further comments and suggestions. + * when done with the full review click on the `Finish your review` button on the top right corner of the page: + - you can comment on your review and choose one of the following options `Comment`, `Approve`, `Request changes`. Select the approprate option and click on `Submit review`. + +## Making a ready for review pull request (Learner) -## Making changes +- Once you and your review partner have agreed on the code review (i.e. Your review partner has approved your draft pull request), covert your draft pull request to ready to review. +- On the right side panel, you should invite the teacher to review your pull request. +- The teacher will go through the changes that you made on the original file and suggest changes through code review as your review partner did. -## Teacher merges pull requests +## Merges pull requests (Teacher) - Once both teacher and learner are satisfied with the updates, the teacher merges the learner's pull request into their lesson branch. -- Once the teacher has updated their lesson branch with the input from all learners, the teacher merges the lesson branch into the main branch. +- Once the teacher has updated their lesson branch with the input from all learners, the teacher merges the lesson branch into the main branch, after fixing any consistency or potential rendering issues.