Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add ADR #1728

Merged
merged 1 commit into from
Feb 7, 2025
Merged

Add ADR #1728

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .adr-dir
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
adr
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,3 +70,9 @@ Some of the Saleor apps are available in separate repositories:
## Development

You can find the documentation for saleor/apps on [docs.saleor.io](https://docs.saleor.io/docs/3.x/developer/app-store/development).

## ADR

This repository uses [architecture decision records](https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions) to document architectural decisions. You can find them in the `docs/adr` directory.

To add new ADR follow [the guide](https://github.com/npryce/adr-tools).
19 changes: 19 additions & 0 deletions adr/0001-record-architecture-decisions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# 1. Record architecture decisions

Date: 2025-02-07

## Status

Accepted

## Context

We need to record the architectural decisions made on this project.

## Decision

We will use Architecture Decision Records, as [described by Michael Nygard](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions).

Check warning on line 15 in adr/0001-record-architecture-decisions.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (Nygard)

## Consequences

See Michael Nygard's article, linked above. For a lightweight ADR toolset, see Nat Pryce's [adr-tools](https://github.com/npryce/adr-tools).

Check warning on line 19 in adr/0001-record-architecture-decisions.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (Nygard's)

Check warning on line 19 in adr/0001-record-architecture-decisions.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (toolset)

Check warning on line 19 in adr/0001-record-architecture-decisions.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (Pryce's)
Loading