Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

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

Đang mở
  • Có gì không ổn?
#351 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
35/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
csharp, sqlite
Lĩnh vực
databases, documentation, testing

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
C#
Star
1
Fork
3
Merge trung bình
4 giờ 34 phút
Pull request đã merge (30 ngày)
182

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của CodeForFire/lagebuch

Tất cả issue của CodeForFire/lagebuch

Issue tương tự

Thêm issue về C#

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.