Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

1.0: freeze the .fwincident schema and commit to forward migration

Aperta
  • Qualcosa non va?
#351 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
csharp, sqlite
Ambito
databases, documentation, testing

Direzione di ricerca

Start with src/LageBuch.Persistence/Sqlite/Migrations.cs, README.md, and the existing docs to understand the current schema and migration behavior. Review the historical schema versions, PDF export, and existing migration coverage before deciding what fixtures and tests are needed. Done means the German 1.x compatibility and forward-compatibility rules are documented, old-file fixtures are tested, the schema review is recorded, and export is confirmed as an escape hatch.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

enhancement help wanted

Every incident lives in one .fwincident SQLite file. The README tells users
plainly that the format can still change between versions before 1.0. That
warning is the single biggest reason a Wehr would hesitate to run Lagebuch on a
real Einsatz rather than an Übung.

Version 1.0 means retiring that warning. This issue tracks what has to be true
first.

The mechanism that already exists
  • src/LageBuch.Persistence/Sqlite/Migrations.cs carries CurrentVersion and
    migrates older files forward on open.
  • UnsupportedSchemaVersionException rejects a file written by a newer version
    with a clear message instead of corrupting it.

So the machinery is in place. What is missing is the commitment.

What 1.0 requires
  • A written compatibility guarantee. A file written by 1.x opens in every
    later 1.x. State it in README.md and in docs/, in German, because the
    audience for the promise is the Kommandant, not the developer.
  • Migration tests as a standing gate. A fixture file per historical schema
    version, checked into the repo, with a test that opens each one and asserts
    the migrated result. Today's coverage tests the migration code; this tests the
    actual old files.
  • A schema review before the freeze. One deliberate pass asking what we
    would regret. After 1.0 a mistake costs a migration forever.
  • A documented forward-compatibility story. What a 1.0 build does with a file
    from 1.4. Today it refuses with a message, which is defensible, but it should
    be a stated rule rather than an implementation detail.
  • Export as the escape hatch. PDF export already exists. Confirm it is
    complete enough that a user is never trapped in the format.
Not in scope

Feature work. 1.0 is a promise about the file, not a feature set.

Discussion welcome. This is the milestone that turns Lagebuch from something a
Wehr tries into something a Wehr relies on.

New here?

Comment to claim this issue and it is yours. If no pull request appears within
seven days it goes back in the pool, no hard feelings.

Before you open the PR, please skim CONTRIBUTING.md:
commits need DCO sign-off (git commit -s) and a Conventional Commit subject.
Changes under src/ additionally need an entry under ## [Unreleased] in
CHANGELOG.md — CI fails the PR otherwise.

Questions are welcome right here or in
Discussions.

Lingua principale
C#
Stelle
1
Fork
3
Merge medio
4h 49m
PR unite (30g)
177

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di CodeForFire/lagebuch

Tutte le issue di CodeForFire/lagebuch

Issue simili

Altre issue su C#

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.