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

docs: write docs/testing.md covering the test projects and the headless render harness

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#349 0 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ó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
88/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
csharp
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu với CONTRIBUTING.md, Makefile:49, tests/LageBuch.Acceptance.Tests/TestAppBuilder.cs và BitmapSaveExtensions.cs; kiểm tra tám dự án trong tests/ cùng các assembly tương ứng trong src/. Chạy mọi lệnh được ghi trong tài liệu, bao gồm ví dụ make test có phạm vi thu hẹp và cả hai mục tiêu kiểm thử. Công việc hoàn tất khi docs/testing.md giải thích bố cục dự án, cách lọc, kết xuất headless, kiểm tra PNG và cách phân chia xunit, đồng thời có liên kết từ phần build và kiểm thử của CONTRIBUTING.md.

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

Mô tả

documentation good first issue

CONTRIBUTING.md tells you to run dotnet test and stops there. The repo
actually has eight test projects, a Makefile front end for narrowing a run, and
a headless Skia harness that renders real Avalonia views to bitmaps. None of
that is written down.

What to do

Write docs/testing.md covering:

  • The eight projects under tests/, one per src/ assembly, and what kind
    of test belongs in each.
  • Narrowing a run. make test PROJECT=tests/LageBuch.Domain.Tests FILTER=Name~Formatting.
    Explain why PROJECT is needed when filtering: a bare FILTER fails in
    assemblies that match nothing. The comment at Makefile:49 says so.
  • make test versus make test-all — the first uses the solution filter
    without the Android head, so it works on machines whose JDK is too new.
  • The headless render harness at tests/LageBuch.Acceptance.Tests/TestAppBuilder.cs.
    Explain UseHeadlessDrawing = false: it keeps the real Skia backend so
    embedded custom fonts rasterize, and the default headless stub throws on first
    text layout instead. The comment in that file explains it.
  • Eyeballing render output with the PNG helpers in BitmapSaveExtensions.cs.
  • The xunit version split — LageBuch.Acceptance.Tests is on xunit.v3, the
    others on v2.

Add a link to the new page from the build-and-test section of CONTRIBUTING.md.

Verify

Run every command you put in the document and confirm the output matches what
you wrote.

Difficulty: easy. A good issue if you would rather read a codebase than
change one.

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.