Skip to content

Commit 9fd8d88

Browse files
committed
Document ADR process in README
1 parent fe1f481 commit 9fd8d88

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,10 @@ You might have to refresh by hand after each change.
5454
If you can't see your changes, and you're sure that `npm run dev` is still going, you'll likely need to disable your browser's caching.
5555
Go to the Network tab in your dev tools and toggle "Disable cache".
5656

57+
### Architecture decisions
58+
59+
Significant decisions about how the theme is built are documented in [`docs/adr/`](docs/adr/). Before making a non-trivial change — adding a dependency, changing how a feature works, picking between approaches — please write an ADR. Use [`docs/adr/template.md`](docs/adr/template.md) as a starting point. The goal isn't process for its own sake; it's making sure future contributors understand *why* things are the way they are, not just what they are.
60+
5761
### Deployment
5862

5963
The theme will automatically check, zip, and upload to Ghost via GitHub Actions. If you want to try it yourself locally:

0 commit comments

Comments
 (0)