Skip to content

Commit 419899d

Browse files
committed
release: OpenArc v0.4.0
- Added profile-aware repository scans (repo_profile, adaptive recommendations) - Conditional governance for design, brand, assets based on repo signals - Updated skills, Cursor adapters, README, agent templates - Added test suite for scan profiles
1 parent 3b136c7 commit 419899d

14 files changed

Lines changed: 585 additions & 70 deletions

File tree

.claude-plugin/plugin.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "openarc",
3-
"version": "0.3.1",
3+
"version": "0.4.0",
44
"description": "AI-native repository initialization and governance for sustainable vibe-coded projects.",
55
"author": {
66
"name": "OpenArc"

.codex-plugin/plugin.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "openarc",
3-
"version": "0.3.1",
3+
"version": "0.4.0",
44
"description": "AI-native repository initialization and governance for sustainable vibe-coded projects.",
55
"author": {
66
"name": "OpenArc"

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@ This project follows semantic versioning.
66

77
## Unreleased
88

9+
## 0.4.0
10+
11+
- Added profile-aware repository scans with `repo_profile`, profile-relevant `missing_files`, `all_missing_files`, grouped missing governance, and adaptive recommendations for script, library, app, plugin, docs, and unknown repositories.
12+
- Stopped defaulting script, CLI, automation, library, and docs-only repositories into design, brand, or assets governance unless the repo has matching signals.
13+
- Updated OpenArc skills, Cursor adapters, README, and agent templates so product, design, brand, and asset docs are conditional governance surfaces.
14+
915
## 0.3.1
1016

1117
- Refined README wording for public open-source use.

README.md

Lines changed: 33 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<img alt="Codex plugin" src="https://img.shields.io/badge/Codex-plugin-2563eb?style=for-the-badge&labelColor=4a4a4a">
1515
<img alt="Claude Code plugin" src="https://img.shields.io/badge/Claude%20Code-plugin-7c3aed?style=for-the-badge&labelColor=4a4a4a">
1616
<img alt="Cursor rules" src="https://img.shields.io/badge/Cursor-rules-111827?style=for-the-badge&labelColor=4a4a4a">
17-
<img alt="Version 0.3.1" src="https://img.shields.io/badge/version-0.3.1-84cc16?style=for-the-badge&labelColor=4a4a4a">
17+
<img alt="Version 0.4.0" src="https://img.shields.io/badge/version-0.4.0-84cc16?style=for-the-badge&labelColor=4a4a4a">
1818
<img alt="License MIT" src="https://img.shields.io/badge/license-MIT-daa520?style=for-the-badge&labelColor=4a4a4a">
1919
</p>
2020

@@ -53,7 +53,7 @@ OpenArc gives a repository a small set of durable coordination surfaces:
5353
| Layer | Purpose |
5454
| --- | --- |
5555
| Repository guide | Tells agents how to work in this repo and where source-of-truth docs live. |
56-
| Product, design, and brand docs | Preserve product intent, UI implementation rules, and communication style. |
56+
| Profile-aware product, design, and brand docs | Preserve product intent, UI rules, and communication style only when the repository type needs them. |
5757
| Specs, plans, and tasks | Turn vague requests into scoped, reviewable implementation work. |
5858
| Component pattern governance | Helps agents reuse UI patterns instead of creating duplicate components. |
5959
| Change memory and archive | Keeps recent AI work visible while moving older context out of the active path. |
@@ -314,19 +314,26 @@ The design governance layer gives UI work a reusable-component loop:
314314

315315
## Repository Memory Model
316316

317-
OpenArc uses ordinary repository files as durable memory. Agents read only what is relevant, but the important project context stays versioned with the code:
317+
OpenArc uses ordinary repository files as durable memory. Agents read only what is relevant, and the helper scan classifies repositories as `script`, `library`, `app`, `plugin`, `docs`, or `unknown` before recommending governance files.
318+
319+
Common durable surfaces:
318320

319321
- `AGENT.md` or `AGENTS.md`
320-
- `docs/PRD.md`
321-
- `docs/DESIGN.md`
322-
- `docs/BRAND.md`
323322
- `docs/specs/*.md`
324323
- `docs/plans/*.md`
325324
- `docs/tasks/*.md`
326-
- `docs/assets/*`
327325
- `docs/CHANGELOG_AI.md`
328326
- `docs/archive/`
329327

328+
Conditional surfaces:
329+
330+
- `docs/PRD.md` for product or app repositories.
331+
- `docs/DESIGN.md` for UI, frontend, desktop, mobile, or component work.
332+
- `docs/BRAND.md` for public brand, identity, marketing, naming, or copy work.
333+
- `docs/assets/*` when visual assets or references exist.
334+
335+
Pure script, CLI, automation, library, and docs-only repositories do not need design or brand scaffolding by default.
336+
330337
For public or open-source repositories, OpenArc can also inspect release and maintenance files:
331338

332339
- `CHANGELOG.md`
@@ -362,15 +369,15 @@ python3 plugins/openarc/scripts/openarc.py scan <repo-root> --format json
362369
python3 plugins/openarc/scripts/openarc.py doctor <plugin-root>
363370
```
364371

365-
`scan` identifies missing governance files and recommends the next OpenArc workflow. Public maintenance files such as `CHANGELOG.md`, `CONTRIBUTING.md`, and `LICENSE` are reported separately as optional public files, not as baseline governance gaps for every workspace.
372+
`scan` identifies the repo profile, separates core, delivery, and conditional governance gaps, and recommends the next OpenArc workflow. In JSON output, `missing_files` is profile-relevant while `all_missing_files` keeps the full known governance inventory. Public maintenance files such as `CHANGELOG.md`, `CONTRIBUTING.md`, and `LICENSE` are reported separately as optional public files, not as baseline governance gaps for every workspace.
366373

367374
`doctor` validates the plugin package before publication by checking manifests, required public files, required templates, integration adapters, and skill frontmatter.
368375

369376
## Clarification Flow
370377

371-
OpenArc treats product, design, and brand documents as source-of-truth files. The clarification flow keeps them grounded in repository evidence and confirmed decisions instead of vague filler.
378+
OpenArc treats product, design, and brand documents as conditional source-of-truth files. The clarification flow keeps them grounded in repository evidence and confirmed decisions instead of vague filler.
372379

373-
For `docs/PRD.md`, `docs/DESIGN.md`, and `docs/BRAND.md`, the workflow is:
380+
When the repo profile or user request calls for `docs/PRD.md`, `docs/DESIGN.md`, or `docs/BRAND.md`, the workflow is:
374381

375382
1. Discover existing repo signals: README, package metadata, app screens, docs, copy, design tokens, assets, and recent specs.
376383
2. Separate known facts, unknowns, contradictions, and risky assumptions.
@@ -459,7 +466,7 @@ OpenArc 给仓库提供一组稳定、轻量的协作界面:
459466
| 层级 | 作用 |
460467
| --- | --- |
461468
| 仓库 agent guide | 告诉 agent 如何在这个仓库工作,以及事实来源文档在哪里。 |
462-
| 产品、设计、品牌文档 | 保留产品意图、UI 实现规则和对外表达风格|
469+
| 自适应产品、设计、品牌文档 | 只在仓库类型需要时保留产品意图、UI 规则和对外表达风格|
463470
| specs、plans、tasks | 把模糊需求变成有边界、可审阅的实现工作。 |
464471
| 组件模式治理 | 帮助 agent 复用 UI 模式,而不是重复造相似组件。 |
465472
| 变更记忆和归档 | 让近期 AI 工作保持可见,同时把旧上下文移出活跃路径。 |
@@ -720,19 +727,26 @@ OpenArc 帮助团队避免 AI 构建界面里常见的“一个新需求,一
720727

721728
## 仓库治理基础文件
722729

723-
OpenArc 会在需要时检查这些治理文件:
730+
OpenArc 使用普通仓库文件作为持久记忆。Agent 只读取相关内容,辅助扫描会先把仓库识别为 `script``library``app``plugin``docs``unknown`,再推荐治理文件。
731+
732+
通用持久界面:
724733

725734
- `AGENT.md``AGENTS.md`
726-
- `docs/PRD.md`
727-
- `docs/DESIGN.md`
728-
- `docs/BRAND.md`
729735
- `docs/specs/*.md`
730736
- `docs/plans/*.md`
731737
- `docs/tasks/*.md`
732-
- `docs/assets/*`
733738
- `docs/CHANGELOG_AI.md`
734739
- `docs/archive/`
735740

741+
条件界面:
742+
743+
- `docs/PRD.md`:产品或 app 仓库需要时使用。
744+
- `docs/DESIGN.md`:UI、前端、桌面端、移动端或组件工作需要时使用。
745+
- `docs/BRAND.md`:公开品牌、身份、营销、命名或文案工作需要时使用。
746+
- `docs/assets/*`:存在视觉资产或参考资料时使用。
747+
748+
纯脚本、CLI、自动化、库和文档型仓库默认不需要设计或品牌脚手架。
749+
736750
对于公开或开源仓库,OpenArc 也可能检查发布与维护文件:
737751

738752
- `CHANGELOG.md`
@@ -768,15 +782,15 @@ python3 plugins/openarc/scripts/openarc.py scan <repo-root> --format json
768782
python3 plugins/openarc/scripts/openarc.py doctor <plugin-root>
769783
```
770784

771-
`scan` 用于识别缺失的治理文件,并给出下一步推荐流程。`CHANGELOG.md``CONTRIBUTING.md``LICENSE` 这类公开维护文件会单独作为 optional public files 汇报,不再作为所有工作区的基础治理缺口。
785+
`scan` 会识别 repo profile,拆分 core、delivery、conditional 治理缺口,并给出下一步推荐流程。JSON 输出中,`missing_files` 只表示 profile-relevant 缺口,`all_missing_files` 保留完整已知治理清单`CHANGELOG.md``CONTRIBUTING.md``LICENSE` 这类公开维护文件会单独作为 optional public files 汇报,不再作为所有工作区的基础治理缺口。
772786

773787
`doctor` 用于发布插件变更前校验 manifest、公开文件、模板、平台适配文件和 skill frontmatter。
774788

775789
## 澄清流程
776790

777-
OpenArc 将产品、设计和品牌文档视为事实来源文件。澄清流程的目标,是让这些文档基于仓库证据和已确认决策,而不是用空泛表述补齐未知信息。
791+
OpenArc 将产品、设计和品牌文档视为条件事实来源文件。澄清流程的目标,是让这些文档基于仓库证据和已确认决策,而不是用空泛表述补齐未知信息。
778792

779-
对于 `docs/PRD.md``docs/DESIGN.md` `docs/BRAND.md`,流程是:
793+
当 repo profile 或用户请求需要 `docs/PRD.md``docs/DESIGN.md` `docs/BRAND.md`,流程是:
780794

781795
1. 发现仓库已有信号:README、包信息、应用界面、文档、文案、设计变量、素材和近期规格文档。
782796
2. 区分已知事实、未知信息、矛盾点和高风险假设。

examples/AGENT.example.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,19 @@
44

55
Before implementation, review:
66

7-
- `docs/PRD.md`
8-
- `docs/DESIGN.md`
9-
- `docs/BRAND.md`
7+
- `docs/PRD.md` for product or app work
8+
- `docs/DESIGN.md` for UI, frontend, desktop, mobile, or component work
9+
- `docs/BRAND.md` for public brand, identity, marketing, naming, or copy work
1010
- latest `docs/specs/*`
11-
- `docs/assets/*`
11+
- `docs/assets/*` when visual assets or references exist
1212

1313
## Working Rules
1414

1515
- Spec first for non-trivial work.
1616
- Plan before implementation when multiple files or systems are affected.
1717
- Prefer minimal changes.
1818
- Reuse existing systems.
19+
- Match governance scope to repository profile; script, CLI, automation, library, and docs-only repositories do not need design or brand docs by default.
1920
- Keep diffs reviewable.
2021
- Update specs after implementation.
2122
- Avoid temporary files.

integrations/cursor/AGENTS.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,18 @@ Use OpenArc when this repository needs lightweight AI-native governance, source-
77
1. Scan existing repository files before writing.
88
2. Preserve existing conventions and source-of-truth documents.
99
3. Keep changes small, reviewable, and reversible.
10-
4. Create missing governance files only when no suitable source already exists.
11-
5. Prefer `docs/PRD.md`, `docs/DESIGN.md`, `docs/BRAND.md`, `docs/specs/`, `docs/plans/`, `docs/tasks/`, `docs/CHANGELOG_AI.md`, and `docs/archive/` for durable project context.
12-
6. For UI work, check `docs/DESIGN.md` and existing components before creating a new component.
10+
4. Detect the repo profile before deciding which governance files are missing.
11+
5. Create missing governance files only when no suitable source already exists and the file is relevant to the repo profile.
12+
6. Prefer `docs/specs/`, `docs/plans/`, `docs/tasks/`, `docs/CHANGELOG_AI.md`, and `docs/archive/` for durable delivery and change context.
13+
7. Treat `docs/PRD.md`, `docs/DESIGN.md`, `docs/BRAND.md`, and `docs/assets/*` as conditional surfaces, not universal requirements.
14+
8. For UI work, check `docs/DESIGN.md` and existing components before creating a new component.
1315

1416
## OpenArc Tasks
1517

1618
- For a general "use OpenArc" request, identify the narrowest relevant workflow first.
1719
- For repository setup or drift review, inspect current docs and create or patch an agent guide.
1820
- For product, design, or brand docs, ask only for material unknowns instead of filling gaps with generic guesses.
21+
- For script, CLI, automation, library, or docs-only repos, do not create design or brand docs unless there are UI, visual asset, public product, or identity signals.
1922
- For non-trivial changes, create or update a spec and implementation plan before coding.
2023
- For version changes, use semantic versioning: patch for fixes/docs, minor for backward-compatible additions, major for breaking governance or API/schema changes.
2124
- For migration, inventory first and avoid moving, renaming, deleting, or archiving files without confirmation.

integrations/cursor/openarc.mdc

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ When the user asks to use OpenArc, scan the repository first and choose the smal
1414
- Prefer patching existing docs over replacing them.
1515
- Ask only for material unknowns.
1616
- Do not move, rename, delete, or archive files without confirmation.
17+
- Detect the repo profile before deciding which governance targets are required.
1718
- For non-trivial implementation, create or update a spec and plan before coding.
1819
- For release or packaging work, classify version impact with semantic versioning and update the changelog.
1920
- For UI work, check `docs/DESIGN.md` and existing components before creating a new component.
@@ -23,15 +24,21 @@ When the user asks to use OpenArc, scan the repository first and choose the smal
2324
## Governance Targets
2425

2526
- `AGENT.md` or `AGENTS.md`
26-
- `docs/PRD.md`
27-
- `docs/DESIGN.md`
28-
- `docs/BRAND.md`
2927
- `docs/specs/*.md`
3028
- `docs/plans/*.md`
3129
- `docs/tasks/*.md`
3230
- `docs/CHANGELOG_AI.md`
3331
- `docs/archive/`
3432

33+
Conditional targets:
34+
35+
- `docs/PRD.md` for product or app repositories.
36+
- `docs/DESIGN.md` for UI, frontend, desktop, mobile, or component work.
37+
- `docs/BRAND.md` for public brand, identity, marketing, or copy work.
38+
- `docs/assets/*` when visual assets or references exist.
39+
40+
For script, CLI, automation, library, or docs-only repositories, do not create conditional targets unless repository evidence or the user request calls for them.
41+
3542
If the helper script exists, prefer:
3643

3744
```bash

0 commit comments

Comments
 (0)