Add README, screenshots and wiki in English, Danish and Bahasa Malaysia
CI / Test on Python 3.13 (push) Successful in 55s
CI / Test on Python 3.13 (push) Successful in 55s
Task: MIL-003#1 Task: MIL-003#2 Refs #14 Refs #15 Refs #16 Refs #17 Refs #18
This commit is contained in:
@@ -0,0 +1,43 @@
|
||||
# Udvikling
|
||||
|
||||
🌐 [English](Development) · **Dansk** · [Bahasa Melayu](Development-ms)
|
||||
|
||||
Sæt projektet op først ([Installation](Install-da)). Udvidelsen `dev` installerer pytest, ruff, mypy og import-linter.
|
||||
|
||||
## Kør testene
|
||||
|
||||
```bash
|
||||
python -m pytest
|
||||
```
|
||||
|
||||
## Kør de kontroller, CI kører
|
||||
|
||||
```bash
|
||||
python -m ruff check .
|
||||
python -m mypy
|
||||
lint-imports
|
||||
```
|
||||
|
||||
## Byg kildedokumentationen
|
||||
|
||||
```bash
|
||||
doxygen Doxyfile
|
||||
```
|
||||
|
||||
Åbn `build/html/index.html`. Installér Doxygen fra [doxygen.nl](https://www.doxygen.nl/) eller din pakkehåndtering.
|
||||
|
||||
## Kodens opbygning
|
||||
|
||||
| Mappe | Indhold |
|
||||
| --- | --- |
|
||||
| `src/nato_alphabet/domain/` | Staveregelen, uden input og output |
|
||||
| `src/nato_alphabet/application/` | Use casen og dens porte |
|
||||
| `src/nato_alphabet/adapters/` | CSV-læseren og konsollen |
|
||||
| `src/nato_alphabet/constants.py` | Alle programmets konstanter |
|
||||
| `tests/` | pytest-tests, som spejler `src/` |
|
||||
|
||||
Afhængigheder peger indad: adapters kender applikationen, applikationen kender domænet. import-linter håndhæver det.
|
||||
|
||||
## Pull requests
|
||||
|
||||
Én gren og én pull request pr. milepæl; CI skal være grøn. Projektet følger SQA- og QC-frameworket i `framework/`; se `docs/` for planen og review-optegnelserne.
|
||||
Reference in New Issue
Block a user