fix(shared): add scaffolding rule to treat init output as starter code#423
Open
atilafassina wants to merge 1 commit into
Open
fix(shared): add scaffolding rule to treat init output as starter code#423atilafassina wants to merge 1 commit into
atilafassina wants to merge 1 commit into
Conversation
Add a `must` rule to TEMPLATE_SCAFFOLDING.rules in the canonical manifest schema, instructing scaffolding agents to treat `databricks apps init` output as starter code rather than requirements — adapting or replacing it to match the requested app behavior. Updates the validate-manifest pinning test and regenerates template/appkit.plugins.json via `pnpm sync:template`. Co-authored-by: Isaac Signed-off-by: Atila Fassina <atila@fassina.eu>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the template scaffolding rules so that agents running databricks apps init treat generated output as starter code (modifiable/replacable) rather than a fixed spec, preventing the scaffold from being inadvertently “locked in” when it conflicts with the user’s requested app.
Changes:
- Adds a new must directive to
TEMPLATE_SCAFFOLDING.rules.mustclarifying scaffold output is a starting point, not a requirement. - Updates the manifest pinning test to include the new directive (order and content pinned).
- Regenerates the synced
template/appkit.plugins.jsonartifact to reflect the canonical manifest change.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| template/appkit.plugins.json | Regenerated template manifest artifact including the new scaffolding must rule. |
| packages/shared/src/schemas/manifest.ts | Adds the new canonical TEMPLATE_SCAFFOLDING.rules.must directive for databricks apps init. |
| packages/shared/src/cli/commands/plugin/validate/validate-manifest.test.ts | Updates the pinned expectation for TEMPLATE_SCAFFOLDING.rules.must to include the new directive. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
atilafassina
changed the title
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
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
mustrule to the template manifest's scaffolding ruleset (TEMPLATE_SCAFFOLDING.rules.must):Why
The scaffolding rules steer the AI agent that drives
databricks apps init. Without this directive, an agent can treat the generated starter app as a fixed spec and build around it, rather than adapting/replacing it to match what the user actually asked for. This makes the "scaffold is a starting point" expectation explicit.How
packages/shared/src/schemas/manifest.ts(TEMPLATE_SCAFFOLDING.rules.must). The rule is 117 chars, within the schema's 120-charSCAFFOLDING_RULE_MAX_LENGTH.validate-manifest.test.ts(toEqualonrules.must).template/appkit.plugins.jsonviapnpm sync:template(the JSON is a generated artifact — not hand-edited).Verification
validate-manifest.test.ts— 61 passed (includes the schema-parse + pinning tests)sync.test.ts— 25 passedpnpm --filter shared typecheck— cleanDraft for review of the rule wording before merge.
This pull request and its description were written by Isaac.