General

Comments

• Always provide product context (why are we doing this?) or explanations to an unusual solution (why am I implementing it like that?)
• The goal is for other developers (or yourself in the future) to easier understand the reason for the code to exist.

Use Colocation

Colocation

Handling tech debt

<aside> 💡 We follow the boy scout rule. Refactor as you go when you see potential improvements that can be made to the code you’re touching.

</aside>

Code reviews

• Small and incremental PRs are easier to review. A PR should try to accomplish a singular task or goal.

• Use inclusive language, and if possible, provide suggestions.

  • “You should do this” → “Let’s do this.”
  • “You have a typo” → “ typo: change spelling to XYZ“

• Use Conventional Comments.

  Conventional Comments

Git Strategy

• Do what you want, but you can follow this simple methodology:

How I stopped Git from getting in the way

File names

• camelCase by default