Skip to content

Commit 75f929a

Browse files
andre-salvaticlaude
andcommitted
docs: move CHANGELOG into specs/
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1 parent d08742f commit 75f929a

4 files changed

Lines changed: 4 additions & 4 deletions

File tree

.github/workflows/onpush.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,8 @@ on:
99
paths-ignore:
1010
- 'README.md'
1111
- 'CLAUDE.md'
12-
- 'CHANGELOG.md'
1312
- 'docs/**'
14-
- 'specs/**'
13+
- 'specs/**' # includes specs/CHANGELOG.md
1514
# Manual trigger for re-running CI without a new commit (e.g. after a transient
1615
# GitHub Actions hiccup that silently drops a push event):
1716
# gh workflow run "CI pipeline" --ref <branch>

CLAUDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ The detailed specs live in [`specs/`](specs/) — read the relevant one **before
8585
Favor solutions with less code, fewer classes, and fewer abstractions. When two approaches both solve the problem, prefer the one with fewer moving parts — even if the "cleaner" architecture feels more elegant. Extend existing classes before creating new ones. Add a parameter before adding a new task key. Branch on a flag before splitting into subclasses.
8686

8787
- Don't ship changes to the CLI surface (`main.py:arg_parser`), runtime env vars, catalog/schema model, or production guardrails without updating `README.md`, the relevant doc under `specs/`, and this file (`CLAUDE.md`) in the same commit. Stale docs are worse than no docs — they mislead future contributors and future sessions.
88-
- Don't merge a PR without adding an entry to `CHANGELOG.md` describing what changed and why.
88+
- Don't merge a PR without adding an entry to `specs/CHANGELOG.md` describing what changed and why.
8989
- Don't reintroduce `--user`, `--debug`, or `--schema` CLI args. They were removed deliberately — see PR #21.
9090
- Don't add `funcy` (or any decorator-based timing utility) to the dependencies. Use the structured logger.
9191
- Don't add `CREATE CATALOG` or `CREATE SCHEMA` calls outside the `args.env == "dev"` branch in `config.py`. Staging/prod catalogs and schemas are owned by `make init`; runtime jobs run without those privileges.

CHANGELOG.md renamed to specs/CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## [#40](https://github.com/andre-salvati/databricks-template/pull/40) · 2026-06-11 · docs: reorganize specs into specs/ folder, slim README and CLAUDE.md
66

7-
Extracted the deep technical documentation out of `README.md` and `CLAUDE.md` into a dedicated `specs/` folder (`architecture.md`, `data-model.md`, `test-plan.md` + an index), leaving the README a landing page and `CLAUDE.md` working rules plus load-bearing invariants and pointers.
7+
Extracted the deep technical documentation out of `README.md` and `CLAUDE.md` into a dedicated `specs/` folder (`architecture.md`, `data-model.md`, `test-plan.md`, an index, and `CHANGELOG.md` itself), leaving the README a landing page and `CLAUDE.md` working rules plus load-bearing invariants and pointers.
88
Converted the medallion and CI/CD diagrams to inline Mermaid (GitHub-rendered, diffable) and deleted the now-superseded `docs/medallion_data_flow.png`, `docs/ci_cd.png`, and `docs/ci_cd.drawio`; real UI screenshots stay as PNGs.
99
Added `specs/**` to the `onpush.yml` `paths-ignore` so docs-only changes don't trigger a CI run.
1010

specs/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ relevant spec before working in that area.
1010
| [architecture.md](architecture.md) | the wheel/CLI surface, jobs DAG, job generation, CI/CD, job-level params, deploy-time env vars, logging, or production guardrails. |
1111
| [data-model.md](data-model.md) | the catalog/schema model, medallion flow, table schemas, the price-freeze semantics, liquid clustering, DQX/quarantine, or lineage. |
1212
| [test-plan.md](test-plan.md) | unit, integration, or load tests. |
13+
| [CHANGELOG.md](CHANGELOG.md) | the per-PR change history (add an entry before every merge). |
1314

1415
Diagrams are inline Mermaid (rendered by GitHub) — edit the fenced block, not an image. The
1516
remaining PNGs in `../docs/` are real UI screenshots.

0 commit comments

Comments
 (0)