docs(adr): add ADR template and ADR 0001 target architecture#715
Open
osvaldoandrade wants to merge 1 commit into
Open
docs(adr): add ADR template and ADR 0001 target architecture#715osvaldoandrade wants to merge 1 commit into
osvaldoandrade wants to merge 1 commit into
Conversation
Establish the ADR process and record the target architecture that anchors the refactor epics (#645-#656): - docs/adr/README.md: when to write an ADR, status lifecycle, index. - docs/adr/template.md: reusable skeleton. - docs/adr/0001-target-architecture.md: layered + hexagonal layout, one-way dependency direction, consumer-side interfaces, typed errors, composition in cmd/, enforcement via depguard. Refs #645 #659
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
1 participant
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
Establishes the Architecture Decision Record process and records the target architecture that all refactor epics (#645–#656) build toward.
Files
docs/adr/README.md— when to write an ADR, status lifecycle, index.docs/adr/template.md— reusable skeleton (Context / Decision / Consequences / Alternatives / References).docs/adr/0001-target-architecture.md— the target layout.ADR 0001 in one paragraph
codeq adopts a layered architecture with hexagonal boundaries at storage and transport. Dependency direction is strict and one-way:
cmd → bootstrap → server/application/storage → core → pkg/{types,plugin,auth}. Interfaces are consumer-side. Errors are typed structs ininternal/core/errors. Composition lives incmd/, with no DI framework. Rules are enforced bydepguard(PR #713) and per-layer coverage floors (PR #714), not by convention.Test plan
Closes #659
Part of #645