Process Journal

Your process journal (journal.md) should include three main components:

1) Comprehension Process: Describe the initial steps you’ve taken to understand its structure and functionality, as well as your step by step code navigation journey and code understanding process as best as you can to comprehend key files and functions. You may choose to discuss:

  • The specific code navigation techniques (search terms used, navigation shortcuts used, etc)
  • Debugger breakpoints you used
  • etc.

Try to reflect on how you went about understanding the parts of the codebase that you need to change and how you went about adding the feature.

2) Problem Decomposition: Explain how the task was broken into manageable pieces (Numerous approaches can be adopted for this step. Please exercise discretion in how you present your problem decomposition, whether through pseudocode, an organized list, a diagram, flow charts, or other methods. You are encouraged to come up with your own ideas.)

3) Obstacles Encountered: List major obstacles you’ve encountered during the development process. Describe how these were overcome through specific resources or strategies such as consulting documentation, using forums like StackOverflow, or discussing with peers, or other resources (using Google, ChatGPT, office hours, etc).

  • If you had a specific bug explain how you overcame it