docs: write docs/architecture.md describing the nine-project layout
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 88/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
- 技術スタック
- csharp
調査の方向性
LageBuch.slnと各.csprojファイルのProjectReferenceエントリから始めて、9つのプロジェクトと実際の依存関係を把握してください。プロジェクトの概要、参照グラフ、デスクトップアプリとAndroidアプリのヘッド、および変更箇所の表を含むdocs/architecture.mdを作成し、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分
- マージ済み PR（30日）
- 182
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- 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 日以内に返信