Skip to content

feat: add proto-first guide as databricks-apps reference#41

Merged
keugenek merged 1 commit intomainfrom
evgenii.kniazev/proto-first-skill
Apr 1, 2026
Merged

feat: add proto-first guide as databricks-apps reference#41
keugenek merged 1 commit intomainfrom
evgenii.kniazev/proto-first-skill

Conversation

@keugenek
Copy link
Copy Markdown
Contributor

@keugenek keugenek commented Mar 31, 2026

Summary

Adds proto-first design guidance as reference docs inside the existing databricks-apps skill (per review feedback — not a standalone skill).

Files added:

  • skills/databricks-apps/references/appkit/proto-first.md — 4-phase workflow: decompose → contracts → generate → implement
  • skills/databricks-apps/references/appkit/proto-contracts.md — concrete proto↔plugin mappings for files, lakebase, jobs

SKILL.md updated: Added "Typed data contracts" row to the Required Reading table.

What it covers

  • Module decomposition (files, lakebase, jobs, analytics, server boundaries)
  • Proto style rules (one file per boundary, ≤12 fields, snake_case)
  • Proto→Lakebase DDL type mapping
  • Proto→Plugin method mapping (files upload, lakebase insert, job params)
  • Volume layout convention from proto messages
  • Common traps (any at boundary, JSON.parse, god messages)

Documentation safety checklist

  • Examples use least-privilege permissions
  • Sensitive values are obfuscated
  • No insecure patterns introduced

@keugenek keugenek requested review from a team and lennartkats-db as code owners March 31, 2026 11:43
Copy link
Copy Markdown
Collaborator

@arsenyinfo arsenyinfo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From my understanding of current granularity, that should not be a separate skill in existing taxonomy.
Even appkit itself is not a separate skill but a core recommendation in databricks-apps skill. This proto-first thing is an implementation best practice, i'd expect it to be part of apps skill referenced close to other core appkit practices.

@keugenek
Copy link
Copy Markdown
Contributor Author

From my understanding of current granularity, that should not be a separate skill in existing taxonomy. Even appkit itself is not a separate skill but a core recommendation in databricks-apps skill. This proto-first thing is an implementation best practice, i'd expect it to be part of apps skill referenced close to other core appkit practices.

agree it is more like a meta-skill - how would you recommend implementing it then? (compared to current approach)

@keugenek keugenek changed the title feat: add proto-first skill for schema-first app design feat: add proto-first guide as databricks-apps reference Apr 1, 2026
@keugenek
Copy link
Copy Markdown
Contributor Author

keugenek commented Apr 1, 2026

/merge

@keugenek
Copy link
Copy Markdown
Contributor Author

keugenek commented Apr 1, 2026

isaac-bot pull master and resolve any conflicts.

Adds protobuf schema-first design guidance as reference docs inside
the existing databricks-apps skill.

Files added:
- references/appkit/proto-first.md — 4-phase workflow (decompose,
  contracts, generate, implement) for typed AppKit apps
- references/appkit/proto-contracts.md — proto↔plugin mappings for
  files, lakebase, and jobs boundaries

SKILL.md updated with proto-first in Required Reading table.
Manifest updated with new files, no standalone skill entry.
@keugenek keugenek force-pushed the evgenii.kniazev/proto-first-skill branch from f9cf254 to bdb9815 Compare April 1, 2026 16:28
@keugenek keugenek merged commit 67d31dd into main Apr 1, 2026
1 check failed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants