se-edu / guides

Style guides and tutorials for SE student projects
MIT License
5 stars 18 forks source link

[AB3: Tracing Code] Add context to Introduction #31

Open NeoHW opened 1 week ago

NeoHW commented 1 week ago

Current

Screenshot 2024-06-29 at 6 09 26 PM

Problem

It is mentioned that tracing using a debugger would be useful in understanding an unfamiliar codebase, but not why or how it helps. The current tutorial does not give the background context on why tracing execution paths is important, how it helps and an overview of the tutorial. This might leave beginners who do not know what a debugger is or those unfamiliar with the concept of code tracing to feel lost.

Proposed

Add a detailed introduction that explains the importance of tracing code and what the reader can expect to learn.

## Introduction
Understanding the execution path of a program is crucial for debugging and extending existing codebases. Tracing code helps in identifying how different components interact, where potential bugs may occur, and how changes in one part of the code can affect the entire application. By the end of this tutorial, you will be equipped with the skills to: 
* Set breakpoints effectively.
* Trace the flow of execution through various components.
* Understand the interactions between different parts of the application. 
* Identify and troubleshoot issues within the code.
damithc commented 4 days ago

@NeoHW Can you propose the content to add?

NeoHW commented 3 days ago

@NeoHW Can you propose the content to add?

@damithc Yes, have updated the original content to reflect it