Skip to content

Commit b983904

Browse files
committed
Added a small coding style section to CLAUDE.md
1 parent bbe587b commit b983904

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

CLAUDE.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,12 @@ cd ggsql-jupyter/tests && pip install -r requirements.txt && pytest
9090

9191
Per-folder CLAUDE.md files cover component-specific test guidance.
9292

93+
## Coding style
94+
95+
- **Reuse existing infrastructure and architectural choices.** When adding new code, prefer extending or adapting what is already there over introducing a parallel implementation. If reuse requires changes elsewhere to accommodate the new caller, that is more palatable than implementing the same thing twice.
96+
- **Comments describe the current state of the code.** Do not reference past states, how something used to work, what was changed, or why an earlier approach was abandoned — that history belongs in commit messages and [`CHANGELOG.md`](CHANGELOG.md).
97+
- **[`CHANGELOG.md`](CHANGELOG.md) is the record of user-visible change over time.** Consult it when you need to know when something landed or how behaviour evolved. Update it when adding a feature, changing behaviour, or removing something — but write **one entry per feature**, added when the feature is complete. Don't gradually accrete bullets during development.
98+
9399
## Where to ask which question
94100

95101
- *What does clause/layer/scale X do?*[`doc/syntax/`](doc/syntax/).

0 commit comments

Comments
 (0)