RULES.md

RULES

Adapted from Jmen

General

• KEEP IT SIMPLE
• the most important thing is for the code to be readable
• don't remove duplication too early
• we don't want to over optimize for code that is "convenient" to change, we want it to be SIMPLE to understand
• When tests fail, please provide the specific error message.
• after completing a request, check if any extra unnecessary code has been added, and remove it

Comments

• Do not add comments.
• After you have generated a section of code, remove any comments.
• Instead of adding comments, use meaningful names for variables and functions.

Commands

• Use npm run test scoped to the current test file.
• If test output is truncated (hiding errors), rerun tests without coverage reporting for full output.

Process

• use TDD to implement changes
• write a failing test
• check that the failing test, fails for the expected reason
• check that the failing test error message describes the problem in a way it would be easy to understand later on
• pass the test in the simplest way possible
• refactor the code
• prefer outside-in testing to keep the code easier to refactor later
• if I ask you to implement a change without a test, ask me if it is a change that should be tested

Architecture

• Handlers should only deal with either HTTP requests or event logic, not business logic
• Commands should deal with business logic and should not directly access the database