Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

docs: write docs/architecture.md describing the nine-project layout

Aperta Adatta ai principianti
  • Qualcosa non va?
#348 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
88/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
csharp
Ambito
documentation

Direzione di ricerca

Inizia da LageBuch.sln e dalle voci ProjectReference di ogni file .csproj per mappare i nove progetti e le loro dipendenze effettive. Scrivi docs/architecture.md con i riepiloghi dei progetti, il grafo dei riferimenti, i punti di ingresso delle app desktop e Android e una tabella che indichi dove apportare le modifiche, quindi inserisci un collegamento nella sezione For developers di README.md. Verifica ogni progetto e riferimento controllando i file e accertati che il collegamento nel README funzioni.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
C#
Stelle
1
Fork
3
Merge medio
4h 34m
PR unite (30g)
182

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di CodeForFire/lagebuch

Tutte le issue di CodeForFire/lagebuch

Issue simili

Altre issue su C#

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.