diff --git a/ARCH.md b/ARCH.md index f5669f3..d7ecec5 100644 --- a/ARCH.md +++ b/ARCH.md @@ -1,27 +1,23 @@ # ARCH - [project name] -Architectural decisions and their reasoning. What components are used, how will they communicate, what libraries are to be used... +Architectural decisions and their reasoning. What components are used, how will they communicate, what libraries are chosen... ## Overview -Short description of structure. Diagrams and pictures are helpful. +Short description of what we are building and its structure. 3-5 sentences. ## Tech stack Brief description of technologies to be used. -For example: -- Pyton, 3.11+, Async support required -- Pytest, 8.x, Testing +Example: +- Pyton 3.11+, Async support required +- Pytest 8.x, Testing -## Most important architectural decisions. +## Commands -Examples: - -### Polling vs events -- Decision: Polling every 10s -- Options: Using interrupts -- Why?: More simple to implement. +- Lint: "ruff check src/" +- Test: "pytest tests/ -x --tb=short" ## File structure @@ -30,5 +26,18 @@ src/ config.py tests/ - tests.py + test_main.py + + +## architectural decisions. + +One section per non-obvious decision. What we choose, what we rejected, why. + +Example: + +### Polling vs events +- Decision: Polling every 10s +- Options: Using interrupts +- Why?: More simple to implement. +