CST 338 - Week 3 - Who Reviews the Reviewers?

How fun to do some code review. I often tell early career engineers that as you progress in your career you will tend to read more code than write it, as architectural reviews, design docs and pull request reviews become a major part of a Software Engineer's day.

I reviewed all three of my team members code. Overall it was a good exercise, and especially interesting to see how each of them approached the problem in a different way.

What improvements would you make to your code/what was suggested? 

Definitely some good learnings in looking at other group members code. Just from observation, I think I would likely add a little more thorough explanation in my JavaDoc comments. One of my group members really added a lot of detail there and I could see how helpful that would be looking at the code months from now.

As far as critical feedback to my code, I agree with all of it.

  • Adding Javadoc comments for all methods
  • Use a StringBuilder to increase the efficiency of my makeGuess() function
    • This was interesting to me, since I wasn't familiar with StringBuilder as a primitive in Java

Which unit tests were the hardest to pass?

Getting the makeGuess test to pass was definitely challenging. It's the bulk of the code logic we wrote and having to catch the edge case of already checked letters is not the most intuitive.

How do the existing tests function and could they be improved?

Add tests around getScore(). This is only checked at the very end of a game. It would be good to test how it increments over time.

Test for edge case (same letter guess repeatedly).

Those two improvements above would be how I would improve the overall unit tests on the project.

What did you struggle with?

Mostly language Syntax. I haven't written a ton of Java, so some of the language is unknown to me (like StringBuilder) and doesn't come up immediately. This is something that should change the more I write though!

What did one of your teammates struggle with?

I definitely noticed one of my teammates did not add a lot of comments to their code, which actually made them miss some of functionality. I felt like using the Google Doc Prompt -- and translating that into code comments helped me make sure I was hitting all base requirements.

Was any part of the code a struggle for YOU?

Not too much. IntelliJ also makes it really easy to correct issues automatically. It almost feels like a crutch being able to change types at the click of a button or typecast if you need to.

Was any part of writing the code easy for YOU?

Having a clearly defined UML makes the requirement very clean and in that sense it is easy. You have a very clear requirement for each function which makes the logical process simple.

What was your biggest HW1 victory?

Coming up with something clean that my group partners also thought was clean. Especially as I am no Java pro.

Comments

Post a Comment

Popular posts from this blog

CST 300 - Week 2 - More than just a draft

  Part 1: Review and Reflect Learning Strategy Taking a look first the “Effective Study Skills” document, the top three items I excel in are: Gathering Materials Before You Write: I am good at gathering sources before I write a paper which is a habit I’ve learned from other writing classes. It helps create a mental structure even prior to an outline. How to use your time: I have a routine in life, and it helps me be effective with my time no matter what I’m doing. The value of a schedule: I keep a physical planner / schedule. It’s very helpful to keep track of deadlines. In terms of where I can improve, or where I’m weakest in, it would be the following: Taking Notes: I am not the best note taker. It would be beneficial to try to focus on this more. Reading Multiple-Choice Questions: I have been known to make mistakes on quizzes because I am not thoroughly reading each multiple choice answer. Going slower on tests and quizzes is constantly something I’m trying to do better. Study S...
Read more

CST 300 - Week 5 - Capstone and More

  Part One   Comment 1: https://ys-cs-online.blogspot.com/2025/05/cst300-week-4.html?sc=1748980090430#c3685891391511726203 Comment 2: https://janayecsonline.blogspot.com/2025/05/my-plan-for-future.html?sc=1748988024255#c497986143907138492 Part Two Meeting Analysis Tool Build a tool that allows users to upload transcripts directly from Google Meet, Zoom or Microsoft Teams and does automatic summarization as well as sentiment analysis. Get key insights from meetings you didn’t take a part of! This would be a web-based project using the OpenAI API to handle the LLM aspects. Could be a fun, end to end web product to build. Connect Four Online Build a simple game of connect four online that supports two players. This would be a web-based project that allows us to make a simple, two-player game online. It would be fun to have a basic API service to create rooms automatically, and perhaps a separate web socket service to handle dynamic game events for rendering. Youtube Video Summari...
Read more

CST 300 - Week 4 - Writing With Purpose

  Part One One of my ultimate goals with the CS Online Program is to have a better foundational understanding of computer science concepts. I have years of experience building applications at scale, but am excited to learn more about key concepts. Specifically CST 370 and being able to better understand algorithmic efficiency and complexity. Being able to apply those concepts to commonly used data structures or database queries will help me feel more confident in decisions I am making at work. With a CS Degree in hand, I plan to continue my education and go for an MBA. This should help to round out my business acumen and help me land the leadership roles I’d like to obtain in the future. Part Two My career goal is to be a Director Level leader at a Fortune 500 company. Simple right? Truly I believe this program, along with an MBA will help me qualify for this. I already have the requisite experience, so the education is the last piece! Part Three Hard to say, I feel as if I took it...
Read more