docs: write docs/architecture.md describing the nine-project layout
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 88/100
- Issue 类型
- 文档
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- csharp
调研方向
从LageBuch.sln和每个.csproj文件中的ProjectReference条目开始，梳理九个项目及其实际依赖关系。编写docs/architecture.md，其中包含项目摘要、引用关系图、桌面和 Android 应用头项目，以及一张变更位置表，然后从README.md的For developers部分链接到该文档。根据文件核对每个项目和引用，并检查 README 链接是否有效。
由索引模型根据 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
actualProjectReferenceentries. 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.
- 主要语言
- C#
- 星标
- 1
- 派生
- 3
- 平均合并
- 4 小时 34 分钟
- 30 天内合并 PR
- 182
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
CodeForFire/lagebuch 的其他 Issue
-
bug ux
难度 2/5 1-3 小时 新手友好度 78/100
CodeForFire/lagebuch#714 ·
维护者通常 1 天内回复
-
bug ux
难度 2/5 1-3 小时 新手友好度 75/100
CodeForFire/lagebuch#713 ·
维护者通常 1 天内回复
-
enhancement
难度 2/5 1-3 小时 新手友好度 62/100
CodeForFire/lagebuch#405 ·
维护者通常 1 天内回复
-
documentation good first issue
难度 2/5 1-3 小时 新手友好度 88/100
CodeForFire/lagebuch#349 ·
维护者通常 1 天内回复
-
good first issue ux
难度 1/5 1-3 小时 新手友好度 91/100
CodeForFire/lagebuch#347 ·
维护者通常 1 天内回复
查看 CodeForFire/lagebuch 的全部 Issue
相似的 Issue
-
bug
难度 2/5 1-3 小时 新手友好度 65/100
KnifeLemon/Filee#363 ·
维护者通常 1 天内回复
-
enhancement
难度 2/5 1-3 小时 新手友好度 62/100
-
area-Native untriaged
难度 2/5 1-3 小时 新手友好度 76/100
dotnet/machinelearning#7837 ·
维护者通常 2 天内回复
-
[CI] .trgen-ignore required for several grammars.可能已有人在做 @kaby76 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 72/100
antlr/grammars-v4#5073 ·
维护者通常 1 天内回复
-
[Enhancement]: Add a search box to the Time Zone dropdown可能已有人在做 @idumlupinar 今天认领。 未关闭Status: New
难度 2/5 1-3 小时 新手友好度 85/100
dnnsoftware/Dnn.Platform#7579 ·
维护者通常 2 天内回复