References user story #1

TODO:

• ❓ Answer question Task5_Q1 on Canvas
• 👤 Assign yourself to this task (this will prompt the WorkflowLearning GitHub App to create the task_5_squash_with_link_to_task branch)
• ⏳ Wait (at most) 60 seconds until the WorkflowLearning GitHub App will comment on this task and confirm that the branch task_5_squash_with_link_to_task was created (refresh the page if you don't see the confirmation comment)
• Create a new PR having the base branch master and the compare branch task_5_squash_with_link_to_task
• Edit the description of the PR to reference this task
• 🧠 Understand the commits and file changes made in the PR
• ❓ Answer question Task5_Q2 on Canvas
• 🔄 Refresh this page (to ensure that any commits referencing this task are shown on this page) and scroll all the way to the bottom of the page
• ❓ Answer question Task5_Q3 on Canvas

Starting integration...

• In the PR, integrate the changes into master
• using the Squash and merge option
• with the squashed commit message Closes #5 (#<ID_PR>) and
• with an empty squashed commit extended description (i.e., delete the entire squashed commit extended description, which lists the individual commits that are in the pull request)

Integration completed.

• 👀 Inspect the history of all the branches and commits via Insights -> Network
• ❌ In the PR, use the GitHub interface to delete the branch (since the branch content was successfully integrated into master)
• 👀 Inspect the history of all the branches and commits via Insights -> Network
• 🔄 Refresh this page (to ensure that any commits referencing this task are shown on this page) and scroll all the way to the bottom of the page
• ❓ Answer question Task5_Q4 on Canvas
• ❓ Answer question Task5_Q5 on Canvas

👍 Advantages of this workflow

Any developer inspecting the squashed ("atomic") commit in master can directly navigate

• to task #5 or
• to the PR (to see all the intermediate commits for the implementation)

❗ Disadvantages of this workflow

If the branch contains multiple commits (each containing a partial/incomplete implementation of the task) that are referencing task #5 (like it was the case with branch task_5_squash_with_link_to_task), then these commits will automatically appear in task #5 as being referenced, and this unnecessarily clutters task #5 and confuses any developer trying to understand the changes performed in task #5.

References user story #1

TODO:

• ❓ Answer question Task3_Q1 on Canvas
• 👤 Assign yourself to this task (this will prompt the WorkflowLearning GitHub App to create the task_3_rebase branch)
• ⏳ Wait (at most) 60 seconds until the WorkflowLearning GitHub App will comment on this task and confirm that the branch task_3_rebase was created (refresh the page if you don't see the confirmation comment)
• Create a new PR having the base branch master and the compare branch task_3_rebase
• Edit the description of the PR to reference this task (i.e., the PR description should contain Closes #3)
• 🧠 Understand the commits and file changes made in the PR
• ❓ Answer question Task3_Q2 on Canvas
• 🔄 Refresh this page (to ensure that any commits referencing this task are shown on this page) and scroll all the way to the bottom of the page
• ❓ Answer question Task3_Q3 on Canvas

Starting integration...

• In the PR, integrate the changes into master
• using the Rebase and merge option

Integration completed.

• 👀 Inspect the history of all the branches and commits via Insights -> Network
• NOTE: all the commits from branch task_3_rebase were "copied" (rebased) into the master branch, cluttering the repository history with multiple commits that contain partial (and incomplete) implementations of the task
• ❌ In the PR, use the GitHub interface to delete the branch (since the branch content was successfully integrated into master)
• 👀 Inspect the history of all the branches and commits via Insights -> Network
• NOTE: the branch task_3_rebase was deleted successfully from the repository
• 🔄 Refresh this page (to ensure that any commits referencing this task are shown on this page) and scroll all the way to the bottom of the page
• ❓ Answer question Task3_Q4 on Canvas
• ❓ Answer question Task3_Q5 on Canvas

As a developer, I need to understand how to create pull requests (PRs) linked to tasks, how to integrate changes from branches into the master branch using different workflow integration strategies and how to correctly establish traceability between commits and tasks (and pull requests), so that I will be proficient and effective in working in the remaining sprints of the group project, while emphasizing and practicing software engineering techniques for writing high quality software.

Acceptance Criteria:

• Given a branch with the name task_<ID_of_task_it_implements>_<some_short_task_description> containing changes that are not yet integrated into master, when a new pull request is created (having the base branch master and the compare branch task_<ID_of_task_it_implements>_<some_short_task_description>), then the description of the PR should reference the task it implements (i.e., #<ID_of_task_it_implements>)
• Given the PR for branch task_2_merge, when the branch is integrated into master, then the Merge pull request integration option of the PR should be used, and the commit message should be the default one provided by GitHub (e.g., Merge pull request #<ID_PR> from <yourGitHubUserName>/task_2_merge)
• Given the PR for branch task_3_rebase, when the branch is integrated into master, then the Rebase and merge integration option of the PR should be used
• Given the PR for branch task_4_squash, when the branch is integrated into master, then the Squash and merge integration option of the PR should be used, and the commit message should be the default one provided by GitHub (e.g., Task 4 squash (#<ID_PR>))
• Given the PR for branch task_5_squash_with_link_to_task, when the branch is integrated into master, then the Squash and merge integration option of the PR should be used, and the commit message should be Closes #5 (#<ID_PR>); In this way, any developer inspecting the commit in master can directly navigate to task #5 or to the PR (to see all the intermediate commits for the implementation)
• Given the PR for branch task_6_squash_preferred_project_workflow, when the branch is integrated into master, then the Squash and merge integration option of the PR should be used, and the commit message should be Closes #6 (#<ID_PR>); In this way any developer inspecting the commit in master can directly navigate to task #6 (which will be referenced by only one "atomic" commit containing the final implementation of the task) or to the PR (which will contain all the intermediate commits for the implementation, without any traceability to the task)
• Given a PR for a branch with the name task_<ID_of_task_it_implements>_<some_short_task_description>, when the changes from the branch are successfully integrated into master and the PR is closed, then the branch is deleted (using the GitHub interface)

References user story #1

TODO:

• ❓ Answer question Task6_Q1 on Canvas
• 👤 Assign yourself to this task (this will prompt the WorkflowLearning GitHub App to create the task_6_squash_preferred_project_workflow branch)
• ⏳ Wait (at most) 60 seconds until the WorkflowLearning GitHub App will comment on this task and confirm that the branch task_6_squash_preferred_project_workflow was created (refresh the page if you don't see the confirmation comment)
• Create a new PR having the base branch master and the compare branch task_6_squash_preferred_project_workflow
• Edit the description of the PR to reference this task
• 🧠 Understand the commits and file changes made in the PR
• 👍 Notice that the commits in the branch DO NOT reference this task #6. This is intentional, as to not clutter this task with references of commits containing partial (and incomplete) implementations (that do not contain the entire change in one commit), and which can be altered in subsequent commits in the same branch
• ❓ Answer question Task6_Q2 on Canvas
• 🔄 Refresh this page (to ensure that any commits referencing this task are shown on this page) and scroll all the way to the bottom of the page
• ❓ Answer question Task6_Q3 on Canvas

Starting integration...

• In the PR, integrate the changes into master
• using the Squash and merge option
• with the squashed commit message Closes #6 (#<ID_PR>) and
• with an empty squashed commit extended description (i.e., delete the entire squashed commit extended description, which lists the individual commits that are in the pull request)

Integration completed.

• 👀 Inspect the history of all the branches and commits via Insights -> Network
• ❌ In the PR, use the GitHub interface to delete the branch (since the branch content was successfully integrated into master)
• 👀 Inspect the history of all the branches and commits via Insights -> Network
• 🎉 😄 FUN FACT: the branch task_6_squash_preferred_project_workflow was deleted (more accurately hidden) from the repository, because GitHub keeps all deleted branches indefinitely, which means the commits in the branch (and the PR) can always be accessed
• 🔄 Refresh this page (to ensure that any commits referencing this task are shown on this page) and scroll all the way to the bottom of the page
• ❓ Answer question Task6_Q4 on Canvas
• ❓ Answer question Task6_Q5 on Canvas

👍 Advantages of this "preferred workflow" (which will be used throughout the remaining sprints of the group project)

Any developer inspecting the squashed commit in master can directly navigate

• to task #6, which will be referenced by only one "atomic" commit containing the final implementation of the task, and this commit can be easily deployed or cherry-picked to other branches if needed, or
• to the PR (to see all the intermediate commits for the implementation)

💡 Again, it is important to highlight that the intermediate (and incomplete) commits in the branch task_6_squash_preferred_project_workflow DO NOT reference this task #6 at all, and hence, they do not clutter this task with unnecessary (and confusing) references of partial (and incomplete) commits. Moreover, developers can contribute to the branch without constantly worrying about adding traceability for every intermediate commit, since they only need to establish the traceability to the task and PR once, during the integration.

References user story #1

💡 HINT: Feel free to click the checkboxes below (which serve as a TODO checklist for the task) as you progress through the instructions

TODO:

• ❓ Answer question Task2_Q1 on Canvas
• 👤 Assign yourself to this task (this will prompt the WorkflowLearning GitHub App to create the task_2_merge branch)
• ⏳ Wait (at most) 60 seconds until the WorkflowLearning GitHub App will comment on this task and confirm that the branch task_2_merge was created (refresh the page if you don't see the confirmation comment)
• Create a new PR having the base branch master and the compare branch task_2_merge
• Edit the description of the PR to reference this task (i.e., the PR description should contain Closes #2)
• 🧠 Understand the commits and file changes made in the PR
• ❓ Answer question Task2_Q2 on Canvas
• 🔄 Refresh this page (to ensure that any commits referencing this task are shown on this page) and scroll all the way to the bottom of the page
• ❓ Answer question Task2_Q3 on Canvas

Starting integration...

• In the PR, integrate the changes into master
• using the Merge pull request option
• with the commit message Merge pull request #<ID_PR> from <yourGitHubUserName>/task_2_merge (i.e., the default commit message provided by GitHub)

Integration completed.

• 👀 Inspect the history of all the branches and commits in your repository via the GitHub visualization provided in the GitHub tab Insights -> Network
• ❌ In the PR, use the GitHub interface to delete the branch (since the branch content was successfully integrated into master)
• 👀 Inspect the history of all the branches and commits via Insights -> Network
• NOTE: even though the branch was deleted, the branch trace is still present, cluttering the repository history
• 🔄 Refresh this page (to ensure that any commits referencing this task are shown on this page) and scroll all the way to the bottom of the page
• ❓ Answer question Task2_Q4 on Canvas
• ❓ Answer question Task2_Q5 on Canvas

References user story #1

TODO:

• ❓ Answer question Task4_Q1 on Canvas
• 👤 Assign yourself to this task (this will prompt the WorkflowLearning GitHub App to create the task_4_squash branch)
• ⏳ Wait (at most) 60 seconds until the WorkflowLearning GitHub App will comment on this task and confirm that the branch task_4_squash was created (refresh the page if you don't see the confirmation comment)
• Create a new PR having the base branch master and the compare branch task_4_squash
• Edit the description of the PR to reference this task
• 🧠 Understand the commits and file changes made in the PR
• ❓ Answer question Task4_Q2 on Canvas
• 🔄 Refresh this page (to ensure that any commits referencing this task are shown on this page) and scroll all the way to the bottom of the page
• ❓ Answer question Task4_Q3 on Canvas

Starting integration...

• In the PR, integrate the changes into master
• using the Squash and merge option
• with the squashed commit message Task 4 squash (#<ID_PR>) (i.e., the default commit message provided by GitHub)
  NOTE: do NOT make any changes to the squashed commit extended description (which lists the individual commits that are in the pull request)

Integration completed.

• 👀 Inspect the history of all the branches and commits via Insights -> Network
• NOTE: all the commits from branch task_4_squash were squashed/compressed/bundled into a single "atomic" commit that was added to the master branch
• ❌ In the PR, use the GitHub interface to delete the branch (since the branch content was successfully integrated into master)
• 👀 Inspect the history of all the branches and commits via Insights -> Network
• NOTE: the branch task_4_squash was deleted successfully from the repository, reducing the repository clutter
• 🔄 Refresh this page (to ensure that any commits referencing this task are shown on this page) and scroll all the way to the bottom of the page
• ❓ Answer question Task4_Q4 on Canvas
• ❓ Answer question Task4_Q5 on Canvas