Repository navigation
Add .domain, .arc42, and .backlog knowledge folder structure - #4
Merged
Merged
Conversation
- .domain: per-bounded-context template (domain.md, features.md, model.md, dependencies.md) - .arc42: arc42 documentation guidance and chapter layout - .backlog: epics/features/stories/bugs artifact guidance Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Fold templates directly into the instructions files instead of keeping separate template files, and drop the now-empty knowledge folders (git doesn't track empty dirs; they'll be created on demand). Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Replace the epics/features/stories/bugs subfolder split with a flat .backlog/<item-slug>.md file per top-level item, using chapters for sub-items, matching the domain.md nesting pattern. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Allow .backlog/<concern-type>-<concern-slug>.md, one file per domain, feature, or architecture concern, instead of a single flat backlog file. Filename concern-slug matches the corresponding .domain bounded context folder or .arc42 chapter/topic where applicable. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Introduce .github/instructions/chapter-metadata.instructions.md defining a common fenced 'meta' YAML block (id, status, depends-on, related, issue) that every chapter in these three folders must carry, so a future visualization tool can parse status, dependencies, and cross-folder cross-references. Wire the block into the domain.md/features.md, arc42 chapter, and backlog item/sub-item templates. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
A chapter is now addressed by <path>#<heading-slug> (its natural Markdown anchor) instead of a separately stored id, removing a field that could drift from the actual file path/heading text. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
.domain and .arc42 use draft/proposed/active/deprecated (content lifecycle), .backlog uses draft/ready/in-progress/done/blocked (task progress), instead of one shared vocabulary. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Remove depends-on from .arc42 chapters and from domain.md's Aggregate/Domain Service/Shared Value Objects/Shared Enums blocks — those describe standing structure, not sequenced work, so their relationships belong in model.md/dependencies.md or the related field. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
…nstructions chapter-metadata.instructions.md now points to each folder's own instructions file for its status value set, keeping the shared metadata contract folder-agnostic. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
chapter-metadata.instructions.md now only defines the universal status/ related/issue fields; depends-on (features.md, backlog) and the new implements field (backlog only) are documented in their owning folder's instructions file. implements lets a backlog item point at the .domain feature/aggregate/service or .arc42 chapter it realizes, as a distinct relation from the generic related tag. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
This was referenced Sep 3, 2026
This was referenced Sep 28, 2026
4 of 5 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Introduces three durable knowledge folders and their governing instructions to support future visualization tooling:
All guidance lives in
.github/instructions/(not inside the knowledge folders themselves):domain-knowledge.instructions.mdarc42-knowledge.instructions.mdbacklog-knowledge.instructions.mdchapter-metadata.instructions.md— shared per-chapter metadata contract (fencedmetaYAML block) so a future visualization tool can parsestatus, cross-folderrelatedtags, and GitHubissuelinks. Chapters are addressed by<path>#<heading-slug>rather than a separately stored id.statusvalues are folder-specific (draft/proposed/active/deprecated for domain & arc42; draft/ready/in-progress/done/blocked for backlog).depends-onis scoped to features.md and backlog chapters only.implements(backlog-only) relates a backlog item to the domain/arc42 chapter it realizes.Empty folders are tracked via
.gitkeepfiles.Testing
Documentation-only change; no build/tests applicable.