mpabi
41 lines
1.3 KiB
Markdown
41 lines
1.3 KiB
Markdown
# Opis repozytorium i README serii
|
|
|
|
Seria jest uporządkowaną ścieżką kart. Jej manifest nie kopiuje treści kart;
|
|
przechowuje kolejność, adres repozytorium, gałąź, wersję dokumentu i kontrakt
|
|
uruchamiania zadań.
|
|
|
|
## Manifest `series.json`
|
|
|
|
Najważniejsze pola:
|
|
|
|
- `version` — wersja formatu manifestu;
|
|
- `series`, `org`, `title` — identyfikacja serii;
|
|
- `default_branch` — domyślna gałąź kart;
|
|
- `cards[]` — uporządkowane wpisy kart;
|
|
- `cards[].build` — cele budowania i czyszczenia;
|
|
- `cards[].tasks[]` — cele uruchamiane przez narzędzia ucznia.
|
|
|
|
Schemat znajduje się w `schemas/series.schema.json`, a minimalny manifest w
|
|
`examples/series/series.json`.
|
|
|
|
## Zalecany README serii
|
|
|
|
README serii powinien odpowiadać na pięć pytań:
|
|
|
|
1. Jaki jest rezultat całej ścieżki?
|
|
2. Jakie są wymagania wejściowe?
|
|
3. W jakiej kolejności realizujemy karty i dlaczego?
|
|
4. Z jakich książek, dokumentacji i przykładów korzystamy?
|
|
5. Jaki wspólny kontrakt `PASS` obowiązuje wszystkie karty?
|
|
|
|
Zalecana tabela mapuje:
|
|
|
|
```text
|
|
karta → lekcja → źródło → eksperyment → rezultat → stan
|
|
```
|
|
|
|
README nie zastępuje `series.json`: Markdown opisuje narrację i decyzje,
|
|
natomiast JSON jest kontraktem maszynowym dla narzędzi.
|
|
|
|
Przykład znajduje się w `examples/series/README.md`.
|