[docs] Introduce required/optional OB1 compatibility contract#186
Open
justfinethanku wants to merge 1 commit into
Open
[docs] Introduce required/optional OB1 compatibility contract#186justfinethanku wants to merge 1 commit into
justfinethanku wants to merge 1 commit into
Conversation
Breaking schema change: requires.open_brain migrates from the boolean const true to a string enum of required | optional. Why: the old contract implied every contribution in this repo depends on a running Open Brain setup. Many skills (competitive-analysis, panning- for-gold, financial-model-review, etc.) are useful on their own — Open Brain integration is additive for them, not required. The new contract lets the catalog and the public directory surface that distinction accurately instead of overselling the dependency. Changes: - .github/metadata.schema.json: open_brain becomes a string enum - Bulk update 66 metadata.json files (required for all non-skills contributions; required for auto-capture, autodream-brain-sync, weekly-signal-diff, work-operating-model skills; optional for the nine standalone skill packs named in the plan) - CONTRIBUTING.md: new contract documented, both values explained - extensions/_template/AGENT_SPEC.md: template sample updated - README.md: short note under skills explaining most are optional - skills/README.md: new "Works without OB1?" column, compatibility legend, and a note in the contributing section about the field Validated locally with check-jsonschema against every non-template and template metadata.json — all pass. The ob1-pr-followups.yml and ob1-gate.yml workflow paths still match existing filenames; no workflow renames in this PR. The catalog generator that depends on this contract ships next in PR2. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
7 tasks
Collaborator
|
The required/optional compatibility-contract idea reads well. The blocker is scope: this change spans 71 files, including a breaking Recommend author refresh, and worth considering a split — the schema plus — Alan (community reviewer; non-binding) |
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.
Summary
requires.open_brainmigrates from the boolean consttrueto a string enum:"required" | "optional".metadata.json(66 files total) to the new shape and reclassifies the nine standalone skill packs as"optional".skills/README.mdwith a new Works without OB1? column and a compatibility legend. Adds a one-paragraph note under the skills section of the rootREADME.md.Why this change
The old contract forced every contribution to declare
open_brain: true, which overstated the dependency. Many skills inskills/(competitive-analysis, deal-memo-drafting, financial-model-review, meeting-synthesis, research-synthesis, heavy-file-ingestion, n-agentic-harnesses, panning-for-gold, claudeception) are genuinely useful on their own — Open Brain hooks are additive, not required.The new contract lets the upcoming community catalog (PR2) and the public
/ob1directory on natejones.com (separate repo) surface that distinction accurately instead of overselling the dependency.Classification decisions in this PR
"required". Nothing in those categories works without the core OB1 stack in v1."required"(4):auto-capture,autodream-brain-sync,weekly-signal-diff,work-operating-model— each explicitly calls OB1 MCP tools or depends on OB1 data shapes."optional"(9):claudeception,competitive-analysis,deal-memo-drafting,financial-model-review,heavy-file-ingestion,meeting-synthesis,n-agentic-harnesses,panning-for-gold,research-synthesis.Files changed
.github/metadata.schema.json— enum swap, description updatedCONTRIBUTING.md— documents the new contract + both valuesextensions/_template/AGENT_SPEC.md— template sample updatedREADME.md— short note under/skillsexplaining the splitskills/README.md— new column, legend, and contributing guidancemetadata.json— bulk migration to"required"or"optional"Follow-up PR
PR2 ships the catalog generator script plus the committed
resources/ob1-catalog.jsonartifact and a gate drift check. PR2 depends on this contract landing first.In-flight contribution branches
Any open PR whose
metadata.jsonstill setsopen_brain: truewill fail theMetadata validcheck after this merges. Maintainer-side fix on merge is the expected remediation (contributor volume is low). We should post a short note on the repo discussion / Discord once this lands so active contributors can rebase.Test plan
check-jsonschema --schemafile .github/metadata.schema.json <every metadata.json>passes locally (all 66 files)[docs]-tagged PRs (line 75 inob1-gate.yml)🤖 Generated with Claude Code