@chriskealley/openroad 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -76,6 +76,8 @@ Lifecycle statuses are `planned`, `ready`, `active`, `done`, and `cancelled`. On
|
|
|
76
76
|
|
|
77
77
|
The CLI is TypeScript compiled to ES modules. Node.js 22 or later is required to build and test; the repository has one runtime dependency (`yaml`) and no build tooling beyond `tsc`.
|
|
78
78
|
|
|
79
|
+
This repository uses OpenSpec for user-visible behavior and workflow changes. Start a change with the installed OpenSpec workflow, keep its artifacts under `openspec/changes/`, and archive it after implementation and validation. Small maintenance changes that do not alter behavior may remain lightweight.
|
|
80
|
+
|
|
79
81
|
```sh
|
|
80
82
|
git clone https://github.com/chriskealley/openroad.git
|
|
81
83
|
cd openroad
|
|
@@ -89,6 +91,8 @@ npm test
|
|
|
89
91
|
| `npm test` | Build, then run the suite with the Node test runner |
|
|
90
92
|
| `npm run typecheck` | Type-check without emitting output |
|
|
91
93
|
|
|
94
|
+
OpenSpec project context and artifact rules live in `openspec/config.yaml`. Generated Codex workflow skills live in `.agents/skills/` and should be refreshed with `openspec update` after upgrading OpenSpec.
|
|
95
|
+
|
|
92
96
|
Sources live in [src/](src/); `cli.ts` handles argument parsing, `installer.ts` manages the managed-file lifecycle and `.openroad.json` manifest, `config.ts` merges and removes the OpenSpec `config.yaml` guidance, and `roadmap.ts` parses and validates `roadmap.md`. The roadmap template shipped to new projects is [templates/roadmap.md](templates/roadmap.md), and the agent skills are in [skills/](skills/).
|
|
93
97
|
|
|
94
98
|
Two behaviours are worth preserving when changing the installer or parser, and both are covered by tests: installing and removing must leave an existing `openspec/config.yaml` byte-identical, and the shipped roadmap template must validate cleanly under `openroad doctor`.
|