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/architecture.md describing the nine-project layout

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#348 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 LageBuch.sln và các mục ProjectReference trong từng tệp .csproj để lập bản đồ chín dự án và các phần phụ thuộc thực tế của chúng. Viết docs/architecture.md với phần tóm tắt các dự án, đồ thị tham chiếu, các điểm đầu ứng dụng desktop và Android, cùng một bảng chỉ rõ vị trí cần thay đổi, rồi liên kết tài liệu này từ mục For developers trong README.md. Đối chiếu từng dự án và tham chiếu với các tệp, đồng thời kiểm tra để đảm bảo liên kết trong README hoạt động.

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

docs/ holds master-data.md and releasing.md. There is nothing that explains
how the nine projects under src/ fit together, so a new contributor has to
reconstruct the layering from .csproj files before they can judge where a
change belongs.

What to do

Write docs/architecture.md. Everything you need is readable from
LageBuch.sln and the ProjectReference entries in each .csproj — no domain
knowledge and no running the app required.

Cover:

  • The nine projects and one sentence each on what lives there:
    LageBuch.Domain, LageBuch.Persistence, LageBuch.Documents,
    LageBuch.Sync, LageBuch.Sync.Hosting, LageBuch.AppLogic,
    LageBuch.App.Shared, LageBuch.App, LageBuch.App.Android.
  • The reference graph — which project may reference which, derived from the
    actual ProjectReference entries. A small diagram or a nested list both work.
  • The two app heads, desktop and Android, and what they share through
    App.Shared.
  • Where a change goes — a short "if you are changing X, look in Y" table.
    This is the part that saves a newcomer the most time.

Describe what the code does today. If you notice a reference that looks wrong,
mention it in the PR rather than documenting an intention.

Link the new page from the For developers section of README.md.

Verify

Check that every project name and reference you wrote matches the .csproj
files, and that the README link resolves.

Difficulty: easy to medium. No C# required, just careful reading.

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ờ 49 phút
Pull request đã merge (30 ngày)
177

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.