Decision record#89
Merged
Merged
Conversation
- Created docs/adr/ directory - Added ADR-0001 to document the ADR process itself - Added ADRs 0002-0007 for existing architectural decisions (PostgreSQL, TypeORM, JWT, NestJS, Winston, Security/Validation) - Created docs/adr/README.md as an index for all ADRs - Updated CONTRIBUTING.md with the ADR process instructions Co-authored-by: gloskull <189399494+gloskull@users.noreply.github.com>
…61572560214971057 Add Architecture Decision Records (ADRs) directory and document key decisions
Contributor
|
ADRs landing in their own folder is exactly what we needed. Thanks for setting this up — merged. |
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
2 participants
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.
This PR implements the Architecture Decision Records (ADRs) system as requested in issue #77.
Key changes:
Created docs/adr/ directory.
Added 0001-record-architecture-decisions.md following Michael Nygard's format.
Documented existing key decisions:
ADR-0002: PostgreSQL for relational data
ADR-0003: TypeORM for NestJS integration
ADR-0004: JWT with refresh tokens for authentication
ADR-0005: NestJS as the primary framework
ADR-0006: Winston for structured logging
ADR-0007: Security and validation defaults
Created an index file docs/adr/README.md.
Updated CONTRIBUTING.md to include the ADR process for future contributors.
These records provide essential context for the current codebase architecture and establish a process for documenting future major decisions.
Closes #77