programming-and-coding

Programming and Coding

Core principles

• KISS — prefer the simplest correct solution; if code needs a paragraph to explain, simplify it.
• YAGNI — build for the task in front of you, not a hypothetical future. Make the smallest change that works; don't add features, abstractions, or configuration nobody asked for.
• Clarity over cleverness; explicit over implicit; flat over nested. Readability beats micro-optimization unless performance is measured and critical.
• DRY carefully — DRY is about duplicated knowledge, not similar-looking code. Prefer simple duplication over premature coupling.
• Boring tools first — stdlib / base language, then established libraries, before anything exotic.
• Incremental changes — baby steps. Small, testable changes that do the minimal work.
• Working code is documentation — express intent through names, types, and structure; comments explain why.
• Premature optimization is the root of all evil - make it run, make it correct, make it fast, in that order.
• Be super careful where code could generate costs, particularly hitting remote resources and subscriptions.

Code structure and style

• Use descriptive names: firm_panel instead of df2, event_window instead of tmp, treatment_group instead of x, adminUserEmail instead of email.
• Write small, focused functions (~20 lines). One thing per function. Prefer pure functions: same input, same output.
• Use types, classes, and structures to make impossible states impossible (or difficult) to represent.
• Keep files small. Check with wc -l. Aim for <500 lines.
• Prefer deep, useful modules with simple interfaces over many shallow abstractions.
• Name intermediate conditions; optimize for debugging and reader working memory, not fewest lines.
• Make state explicit, small, and owned. Avoid ambient globals, hidden mutation, and action-at-a-distance.
• Prefer immutable data if convenient. Otherwise localize mutations to where ownership is obvious and prefer copy-at-boundaries if practical.
• Prefer side effects at the edges: CLI, HTTP, DB, filesystem, clock, randomness, network.