Writing Your Project Log

In addition to completing the project, your group will need to maintain a log of who does what throughout the project. The log should be written in the README provided in your git repo, and updated consistently to reflect the group’s progression. This is a mandatory part of all projects in this course. If the project log is not updated completely and properly, you are unable to have in-person OH or code reviews with your TAs.

We have many reasons we are having you keep a detailed logs. First, it is a real-world practice that is common in software engineering, so it is good to get into practice. Second, reading the log helps you better understand what other members of your group have worked on, and any bugs they may have faced that you may also encounter. Finally, it helps your Mentor TAs understand where you are in the project, allowing them to help you better.

In terms of what we expect, for each entry, you should include the following

• Who was working
• What day/time they were working (specific start and end times are necessary here)
• Part of the project worked on - feel free to be as descriptive as necessary
• Bugs encountered, and how they were solved
• Resources used (people, documentation on the site, resources on the internet). If you are ever unsure about whether you can use a resource, please consult the course collaboration policy or ask your Mentor TAs

Examples

Some entries from an example log could look like the following:

Wednesday, 3/23, 9:30 - 11:30pm

• WHO: Sarah and Alice
• WHAT: Working on wc.c, particularly reading in characters from a file
• BUGS: We kept reading past the end of the file, so our while loop would run forever. We fixed this by reading the documentation for fread to figure out how to check the return condition correctly, and changing our code accordingly
• RESOURCES USED: https://sof.tware.design/22sp/docs/fread

Thursday, 3/24, 10:00 - 12:00pm

• WHO: Sarah
• WHAT: Implemented longest.c
• BUGS: I had trouble with printing my longest words, so I messaged our TA in the group chat and they suggested I wasn’t null terminating my strings properly. After rereading the part about this in the spec and my lab01 code, I was able to fix my issue by making sure I had the ‘\0’ character at the end of all my strings
• RESOURCES USED: TA Jane Doe

Thursday, 3/24, 11:00 - 12:00pm

• WHO: Alice
• WHAT: Implemented vector.c. Wrote both the methods specified in the h file, and some additional methods to help me test that my implementation works in vector_test.c.
• BUGS: None
• RESOURCES USED: None