Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

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

Abierto
  • ¿Algo no está bien?
#351 1 comentario 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
35/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
csharp, sqlite
Área
databases, documentation, testing

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
C#
Estrellas
1
Forks
3
Merge medio
4 h 49 min
PR fusionados (30 d)
177

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de CodeForFire/lagebuch

Todos los issues de CodeForFire/lagebuch

Issues similares

Más issues de C#

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.