[TECH ED] Code review

[kostiantynkovalchuk]

@SallyMcGrath cloned issue Migracode-Barcelona/Module-JS3#44 on 2024-07-05:

Link to the coursework

https://claude.ai

Why are we doing this?

With code review, you are practising how to talk and write about code. Writing clearly and simply for other people is an essential professional skill. If you've been depending on AI to do this for you up til now, you must seriously consider how realistic your plans are to operate in a professional environment. Use writing tools to develop your own skills, not to replace them.

Use simple, straightforward writing in comments, code review, and documentation. Make your work stand out.

Maximum time in hours (Tech has max 16 per week total)

1

How to get help

1. Install Grammarly and use it.
2. Install a spellchecker in VSCode.
3. Use Hemingway App to check your writing.
4. Ask Claude.ai to revise and review your work, and give you tips to improve it.

Prompt Claude like this:

"Hello Claude. I'm a software engineer working on improving my code review and communication practice. I want to make my writing simple, clear, straightforward, friendly, and accurate. In code review I focus on clarity, simplicity, precision, and security. I will paste you my review and I'd like you to offer some improvements and explain them. I will make some changes and then we'll revise again together. Say okee dokee if you understand."

How to submit

Submit your feedback as a PR review on GitHub.

How to review

Add your buddy and another colleague to your PR as a reviewer on your TV Show Project. Ask someone who has yet to be tagged so people aren't overloaded. Now do a code review for whoever has asked for your review.