TheDeww555 / CS471WorkflowsHomeworkAssignment

0 stars 0 forks source link

Squash with Traceability to Task and PR in Commit Message Integration Strategy, but with Some Commits in the Branch Referencing the Task #5

Open TheDeww555 opened 6 months ago

TheDeww555 commented 6 months ago

References user story #1

TODO:

Starting integration...

Integration completed.

:thumbsup: Advantages of this workflow

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

: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.