feat: add dev-best-practices skill, deprecate databricks-config#298
feat: add dev-best-practices skill, deprecate databricks-config#298michael-berk wants to merge 2 commits intodatabricks-solutions:mainfrom
Conversation
Adds a new skill distilled from the FDE Technical Playbook (Niall Turbitt, AI FDE) covering engineering best practices for Databricks FDE engagements: Git workflow, code quality, software architecture, Databricks platform patterns, CI/CD, testing philosophy, and production handoff. - CREATE databricks-skills/databricks-fde-playbook/ (6 files): SKILL.md, 1-foundations-and-setup.md, 2-code-quality.md, 3-architecture.md, 4-databricks-platform.md, 5-productionization.md - DELETE databricks-skills/databricks-config/ - MCP-specific workspace switching with no standalone value; CLI auth covered by FDE playbook - UPDATE databricks-python-sdk and databricks-asset-bundles SKILL.md with cross-references to the new FDE playbook skill Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
| - **[databricks-spark-declarative-pipelines](../databricks-spark-declarative-pipelines/SKILL.md)** - pipeline definitions referenced by DABs | ||
| - **[databricks-app-apx](../databricks-app-apx/SKILL.md)** - app deployment via DABs | ||
| - **[databricks-app-python](../databricks-app-python/SKILL.md)** - Python app deployment via DABs | ||
| - **[databricks-config](../databricks-config/SKILL.md)** - profile and authentication setup for CLI/SDK |
There was a problem hiding this comment.
We are dropping this skill in favor of FDE playbook
…e FDE references - Rename skill directory and update name/description in SKILL.md - Generalize all FDE-specific language in sub-files - Update cross-references in databricks-asset-bundles, databricks-python-sdk, databricks-zerobus-ingest - Update app.yaml ENABLED_SKILLS and databricks-skills/README.md - Fix stale databricks-config references from deprecation Co-authored-by: Isaac
michael-berk
changed the title
|
Synced over slack and should be ready to merge. If you stamp, would appreciate a merge as well. Thanks a bunch! |
dustinvannoy-db
left a comment
dustinvannoy-db
left a comment
There was a problem hiding this comment.
Suggesting we remove some of the more team specific and internal flow references. Have you tested that this will still help you with auth? I think maybe we should modify databricks-config and leave it as an option to manually invoke, which I could help with those changes.
|
|
||
| ## 2. Development Environment Setup | ||
|
|
||
| ### 2.1 Initial Developer Setup Checklist |
There was a problem hiding this comment.
This section doesn't fit well in this shared repo. Would you be ok with out it?
|
|
||
| ### 2.4 IDE Setup (VSCode / Cursor) | ||
|
|
||
| See Databricks public documentation and internal search tools (Glean) for Databricks-specific IDE advice. |
There was a problem hiding this comment.
Can this be removed? Refers to Glean which won't be available to all Dev Kit users.
|
|
||
| ```bash | ||
| # install CLI | ||
| brew tap databricks/tap && brew install databricks |
There was a problem hiding this comment.
Mac specific, and we check for this on dev kit install. Can this be removed and just call out that Databricks CLI is a dependency? LLM can probably figure out how to upgrade it for the specific environment if needed.
|
|
||
| ```bash | ||
| # Good - clear ownership | ||
| niall/add-billing-retry-logic |
There was a problem hiding this comment.
Replace niall with something like {username}.
@calreynolds is this how we want people contributing to dev kit to work? If so let's leave it, otherwise it is too opinionated for this repo I think.
|
|
||
| ```toml | ||
| [tool.ruff] | ||
| line-length = 88 |
There was a problem hiding this comment.
Can we go higher, this project uses 120 after seeing the default Ruff formatting.
2 participants
Summary
dev-best-practicesskill with 5 comprehensive reference docs covering foundations, code quality, architecture, Databricks platform,and productionization
databricks-configskill (content superseded by the new skill)databricks-asset-bundles,databricks-python-sdk, anddatabricks-zerobus-ingestskillsTest plan
dev-best-practicesSKILL.md trigger conditions are correctdatabricks-configdeprecation is clean (no stale references)This pull request was AI-assisted by Isaac.