docs: add CLAUDE.md for layered feature-module convention#2037
Closed
rugpanov wants to merge 1 commit into
Closed
Conversation
Contributor
Author
|
🤖 Integration tests ❌ 2 of 35 test jobs failed for |
*Why:* We are gradually moving the extension's src/ toward a layered structure, starting with the new python-setup feature. Capturing the convention in a package-scoped CLAUDE.md makes it a documented decision rather than something inferred from one feature folder, so future contributors follow it instead of diverging. *What:* - New `packages/databricks-vscode/CLAUDE.md` with a "Code organization" section: feature-first folders with internal models / utils / gateways / controllers / handlers layers, the one-way dependency rule (handlers -> controllers -> gateways -> utils -> models), what belongs in each layer, and tests-next-to-source. - Documents migration status: the layout is not yet repo-wide; prefer it for new features, migrate existing ones deliberately in their own PRs. Points at src/python-setup/ as the reference template and the proposal doc for rationale. *Verification:* - Docs-only change; no code touched. Co-authored-by: Isaac
rugpanov
force-pushed
the
rugpanov/claude-md-layered-structure
branch
from
July 23, 2026 09:31
bc12de6 to
0ddf2aa
Compare
Contributor
|
If integration tests don't run automatically, an authorized user can run them manually by following the instructions below: Trigger: Inputs:
Checks will be approved automatically on success. |
Contributor
Author
|
🤖 Integration tests ✅ all 35 test jobs passed for |
rugpanov
marked this pull request as draft
July 23, 2026 11:20
Contributor
Author
|
Closing: the standalone layered (models/utils/gateways/controllers/handlers) convention is being set aside. Code conventions will instead iterate from #2043 (matching the current codebase style). The useful, layering-neutral observations from this effort are being folded into that doc. |
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
1 participant
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.
What
Adds a package-scoped
packages/databricks-vscode/CLAUDE.mddocumenting the layered feature-module convention we're adopting forsrc/:models/controllers/handlerslayers.handlers → controllers → models.src/python-setup/(added in [1/?] feat(python-setup): add setup-local CLI result contract types & golden fixtures #2036) as the reference template.Why
We're gradually moving the extension toward this structure, starting with the new
python-setupfeature. Capturing the convention makes it a documented decision rather than something inferred from one feature folder, so contributors (and agents) follow it consistently instead of diverging.Kept as its own PR — a repo-wide convention shouldn't ride inside a feature PR.
Verification
Docs-only; no code touched. Single new Markdown file.
This pull request and its description were written by Isaac.