diff --git a/INDEX.md b/INDEX.md index 41a4352..c52886e 100644 --- a/INDEX.md +++ b/INDEX.md @@ -16,8 +16,8 @@ Agent-owned navigation map for the shared OpenCode workspace. - `rules/` - durable instructions loaded by `opencode.json`. - `skills/` - specialized workflows that can be loaded on demand. - `plugin/` - optional Graphify OpenCode integration. -- `docs/tasks/` - source-repository task guide and local implementation specs - linked from public Issues. +- `docs/tasks/` - source-repository task guide and local implementation specs for + accepted work. - `.github/workflows/ci.yml` - read-only contributor CI that runs `task test`. - `opencode.json` - runtime configuration that loads shared instructions, plugins, MCP servers, and permissions. diff --git a/README.md b/README.md index e0c449c..2f1f29b 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,8 @@ multiple repositories via a checked-out `.opencode/` directory. - `commands/` - shared slash-command definitions - `rules/` - shared durable workflow and editing rules - `skills/` - shared reusable skills -- `docs/tasks/` - local implementation specifications linked from public Issues +- `docs/tasks/` - local task guide and implementation specifications for accepted + repository work - `CONTRIBUTING.md` - repository-specific source contribution workflow - `LICENSE` - Zero-Clause BSD license for Codegeist-owned material - `README.md` - this source repository's contributor and maintainer guide; it is diff --git a/docs/tasks/T001_add-shared-rule-contributor-walkthrough.md b/docs/tasks/T001_add-shared-rule-contributor-walkthrough.md deleted file mode 100644 index 68ebd28..0000000 --- a/docs/tasks/T001_add-shared-rule-contributor-walkthrough.md +++ /dev/null @@ -1,49 +0,0 @@ -# T001 Add Shared Rule Contributor Walkthrough - -Status: open - -Public Tracking: https://github.com/codegeist-ai/codegeist-agent-kit/issues/2 - -Contribution Level: beginner (`good first issue`) - -Effort: small - -## Goal - -Add a beginner-safe documentation walkthrough showing how a contributor can -propose one generic shared rule without editing generated release or consuming -submodule files. - -The repository currently explains the ownership boundary and normal check, but -does not provide an end-to-end example of a small shared rule change. - -## Acceptance Criteria - -- A focused guide follows one fictional rule from the root `rules/` source path - through any required `opencode.json` registration and release documentation - decision. -- The guide contrasts a genuinely generic rule with behavior that belongs in a - consuming repository's `.oc_local/` overlay. -- The example directs contributors to run `task test` and explains that they do - not publish `release` or update consuming submodules. -- `CONTRIBUTING.md` and `INDEX.md` link the walkthrough without duplicating it. -- The documentation introduces no runtime rule or configuration change. - -## Files - -- `docs/contributing/shared-rule-walkthrough.md` -- `CONTRIBUTING.md` -- `INDEX.md` - -## Non-Goals - -- Do not add a real shared rule solely to support the example. -- Do not document maintainer release publication as a contributor step. -- Do not change `.opencode/` or another repository's `.oc_local/` files. - -## Verification - -- Follow the walkthrough against the current source and release path names. -- Verify every new repository-local link resolves. -- Run `task test`. -- Run `git diff --check`. diff --git a/docs/tasks/T002_validate-release-config-references.md b/docs/tasks/T002_validate-release-config-references.md deleted file mode 100644 index 698d3ce..0000000 --- a/docs/tasks/T002_validate-release-config-references.md +++ /dev/null @@ -1,54 +0,0 @@ -# T002 Validate Release Config References - -Status: open - -Public Tracking: https://github.com/codegeist-ai/codegeist-agent-kit/issues/3 - -Contribution Level: intermediate (`help wanted`) - -Effort: medium - -## Goal - -Add deterministic structural validation that catches repository-owned file -references in released OpenCode configuration when their target is missing from -the generated bundle. - -The current release test checks selected known references but does not validate -the complete configured reference set. - -## Acceptance Criteria - -- `task test` validates every repository-owned path referenced by released - `opencode.json` against the copied bundle, including instruction entries, - plugin entries, and file arguments embedded in MCP command arrays such as - `.opencode/playwright-mcp.json`. -- The validation maps `.opencode/...` runtime paths to bundle-relative paths and - explicitly permits documented non-bundle references such as the - consumer-owned root `INDEX.md`. -- A missing target fails with the configuration value and expected bundle path - in the error message. -- Focused regression coverage proves a valid bundle plus missing-target failures - from a top-level list and an MCP command argument without network access or - Git writes. -- Existing release manifest and `INDEX.md` exclusion assertions continue to - pass. - -## Files - -- `tests/release-copy.sh` -- `tests/` for a focused helper or fixture only if needed -- `Taskfile.yml` only if the test entrypoint needs wiring - -## Non-Goals - -- Do not add a full OpenCode JSON schema validator. -- Do not fetch remote MCP, plugin, action, or package references. -- Do not change runtime configuration merely to make validation simpler. -- Do not build or publish the generated `release` branch. - -## Verification - -- Run the focused valid and missing-target assertions. -- Run `task test`. -- Run `git diff --check`. diff --git a/docs/tasks/T003_audit-mutable-tool-action-version-references.md b/docs/tasks/T003_audit-mutable-tool-action-version-references.md deleted file mode 100644 index 72450f2..0000000 --- a/docs/tasks/T003_audit-mutable-tool-action-version-references.md +++ /dev/null @@ -1,65 +0,0 @@ -# T003 Audit Mutable Tool And Action Version References - -Status: open - -Public Tracking: https://github.com/codegeist-ai/codegeist-agent-kit/issues/4 - -Contribution Level: intermediate - -Effort: medium - -## Goal - -Audit executable tool, action, and package references that currently resolve -through mutable or unversioned identifiers, then introduce focused reproducible -pins where they improve contributor CI or released workspace stability without -changing runtime behavior. - -Contributor CI actions and Task are pinned to immutable or exact versions, but -released MCP commands still include references such as `@latest` or unversioned -package names. The repository has no complete inventory, documented exception -list, or deterministic check for newly added mutable executable references. - -## Acceptance Criteria - -- A concise inventory covers executable references in - `.github/workflows/ci.yml` and released `opencode.json`, including GitHub - Actions, `npx`, and `uvx` package inputs. -- Every audited reference is either changed to a focused reproducible pin or - recorded as an intentional exception with a concrete compatibility reason. -- Existing immutable GitHub Action SHAs and the exact Task version remain - documented by the audit; package references selected for pinning use exact - versions supported by their upstream tools. -- A deterministic repository test rejects new unreviewed mutable executable - references and verifies the explicit exception set without network access. -- Existing CI, MCP command shape, Playwright browser settings, and release - bundle behavior remain functionally unchanged. -- Consumer-visible pin changes and update implications are recorded in - `README_release.md`; source-only audit detail stays in source documentation. - -## Files - -- `.github/workflows/ci.yml` -- `opencode.json` -- `tests/` for focused deterministic validation -- `Taskfile.yml` only if the existing `task test` entrypoint needs wiring -- `README_release.md` for consumer-visible changes -- A small source audit document under `docs/` only if rationale does not fit the - test allowlist clearly - -## Non-Goals - -- Do not add an automatic dependency updater or broad lockfile system. -- Do not upgrade tools solely because a newer version exists. -- Do not change MCP capabilities, browser behavior, permissions, or provider - configuration. -- Do not require network access during `task test`. -- Do not build or publish `release`, update consuming gitlinks, or edit nested - submodules. - -## Verification - -- Run the focused mutable-reference inventory and exception assertions. -- Parse `.github/workflows/ci.yml` and `opencode.json`. -- Run `task test`. -- Run `git diff --check`.