reiterate architecture doc stub
This commit is contained in:
35
ARCH.md
35
ARCH.md
@@ -1,27 +1,23 @@
|
|||||||
# ARCH - [project name]
|
# 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
|
## 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
|
## Tech stack
|
||||||
|
|
||||||
Brief description of technologies to be used.
|
Brief description of technologies to be used.
|
||||||
|
|
||||||
For example:
|
Example:
|
||||||
- Pyton, 3.11+, Async support required
|
- Pyton 3.11+, Async support required
|
||||||
- Pytest, 8.x, Testing
|
- Pytest 8.x, Testing
|
||||||
|
|
||||||
## Most important architectural decisions.
|
## Commands
|
||||||
|
|
||||||
Examples:
|
- Lint: "ruff check src/"
|
||||||
|
- Test: "pytest tests/ -x --tb=short"
|
||||||
### Polling vs events
|
|
||||||
- Decision: Polling every 10s
|
|
||||||
- Options: Using interrupts
|
|
||||||
- Why?: More simple to implement.
|
|
||||||
|
|
||||||
## File structure
|
## File structure
|
||||||
|
|
||||||
@@ -30,5 +26,18 @@ src/
|
|||||||
config.py
|
config.py
|
||||||
|
|
||||||
tests/
|
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.
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user