Skip to content

Latest commit

 

History

History
33 lines (23 loc) · 1.09 KB

File metadata and controls

33 lines (23 loc) · 1.09 KB

General

Unless explicitly requested:

  • Do NOT commit
  • Do NOT write tests
  • Do NOT run code or applications

NEVER push code

Never install anything

ASK questions if something is unclear or ambiguous

Always aim for simplicity, clarity, be challenging to achieve this

Code style

  • Use collections.abc for instead of typing where possible
  • Dataclasses: @dataclass(frozen=True, kw_only=True, slots=True)
  • No comments unless explicitly requested
  • Type hints required, mypy in strict mode, avoid using Any
  • Use TypeAlias for type aliases, and Annotated for FastAPI dependencies

Coding

  • Study related code before making changes to fully understand the context
  • Try to remove all unavoidable complexity from the task before you start coding, ask challenging questions if needed
  • Do everything to simplify solutions and remove all unnecessary complexity from the produced code
  • Write clean, modular, readable code
  • Prefer composition, dependency injection
  • Look for general, powerful, clear abstractions
  • Remember the Zen of Python