[ ] :bust_in_silhouette: Assign yourself to this task (this will prompt the WorkflowLearning GitHub App to create the task_5_squash_with_link_to_task branch)
[ ] :hourglass_flowing_sand: 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
[ ] :brain: Understand the commits and file changes made in the PR
[ ] :question: Answer question Task5_Q2 on Canvas
[ ] :arrows_counterclockwise: 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
[ ] :question: 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.
[ ] :eyes: Inspect the history of all the branches and commits via Insights -> Network
[ ] :x: In the PR, use the GitHub interface to delete the branch (since the branch content was successfully integrated into master)
[ ] :eyes: Inspect the history of all the branches and commits via Insights -> Network
[ ] :arrows_counterclockwise: 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
[ ] :question: Answer question Task5_Q4 on Canvas
[ ] :question: Answer question Task5_Q5 on Canvas
:thumbsup: 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)
:heavy_exclamation_mark: 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:
Task5_Q1
on Canvastask_5_squash_with_link_to_task
branch)task_5_squash_with_link_to_task
was created (refresh the page if you don't see the confirmation comment)master
and the compare branchtask_5_squash_with_link_to_task
Task5_Q2
on CanvasTask5_Q3
on CanvasStarting integration...
master
Squash and merge
optionCloses #5 (#<ID_PR>)
andIntegration completed.
Insights
->Network
master
)Insights
->Network
Task5_Q4
on CanvasTask5_Q5
on Canvas:thumbsup: Advantages of this workflow
Any developer inspecting the squashed ("atomic") commit in
master
can directly navigate#5
or:heavy_exclamation_mark: 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 branchtask_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
.