@@ -7,6 +7,9 @@ Containers workflow with the current Codegeist/planner development toolchain.
77
88This repository is a reusable devcontainer kit that can be added to other
99repositories at ` .devcontainer/ ` , either as a Git subtree or as a Git submodule.
10+ The ` main ` branch is the canonical source and contribution target. The generated
11+ ` release ` branch is the runtime-only tree intended for consuming
12+ ` .devcontainer/ ` submodules and is not an implementation target.
1013The source ` Dockerfile.base ` intentionally carries the full
1114Codegeist/planner-style toolchain, including Docker CE, Node 24, VS Code,
1215GitHub CLI, Maven, GraalVM, JBang, Hugo, Nix, PowerShell through ` pwsh ` , Task
@@ -17,6 +20,17 @@ security scan tools, password-store tooling through `pass`, and related CLI
1720tools. The release build publishes this file as
1821` .devcontainer/Dockerfile ` for consuming repositories.
1922
23+ Project work is tracked through
24+ [ GitHub Issues] ( https://github.com/codegeist-ai/codegeist-devcontainer-kit/issues ) ,
25+ the [ Codegeist roadmap listing] ( https://github.com/users/codegeist-ai/projects/1 ) ,
26+ and resumable local specifications described in the
27+ [ task guide] ( docs/tasks/README.md ) . See [ CONTRIBUTING.md] ( CONTRIBUTING.md ) for the
28+ source workflow and extension boundaries. Codegeist's shared
29+ [ Code of Conduct] ( https://github.com/codegeist-ai/.github/blob/main/CODE_OF_CONDUCT.md ) ,
30+ [ Security Policy] ( https://github.com/codegeist-ai/.github/blob/main/SECURITY.md ) ,
31+ and [ Support Policy] ( https://github.com/codegeist-ai/.github/blob/main/SUPPORT.md )
32+ apply to this repository.
33+
2034The consuming project should use the standard VS Code flow:
2135
22361 . Clone the consuming repository.
@@ -373,7 +387,22 @@ If the repository was already cloned without submodules, initialize them later:
373387git submodule update --init --recursive
374388```
375389
376- Run the local test suite from this repository root:
390+ Run the normal fast, deterministic contributor check from this repository root:
391+
392+ ``` bash
393+ task check
394+ ```
395+
396+ This validates shell syntax and the focused source-to-release contract without
397+ building the image, starting Docker, QEMU, Dev Containers, or browsers,
398+ publishing a release, or modifying this repository's Git history. The release
399+ fixture uses a bounded source input list under a cleanup-trapped OS temporary
400+ directory and leaves no ` .test-tmp ` , cache, log, or copied local state in the
401+ source checkout.
402+
403+ Run the broad local test suite when changing image contents, Dev Containers
404+ lifecycle behavior, Docker/Compose integration, QEMU, browser runtime, or another
405+ contract covered only by integration tests:
377406
378407``` bash
379408task tests-run
@@ -431,6 +460,7 @@ The release branch tree contains only:
431460.oc_local.opencode.json.example
432461Dockerfile
433462Dockerfile.example
463+ LICENSE
434464README.md
435465compose.local.yml.example
436466devcontainer.json
@@ -443,7 +473,8 @@ scripts/chrome.sh
443473` scripts/release-build.sh ` copies source ` Dockerfile.base ` into the release tree
444474as ` Dockerfile ` and ships ` Dockerfile.example ` as the on-demand template for root
445475` .codegeist/Dockerfile ` ; do not add a tracked root ` Dockerfile ` to the source
446- checkout for the kit base image.
476+ checkout for the kit base image. The source and generated runtime trees both ship
477+ the canonical 0BSD ` LICENSE ` .
447478
448479## OpenCode Workspace
449480
@@ -1021,3 +1052,13 @@ Prefer:
10211052- The base image currently keeps the copied Codegeist/planner toolchain intact;
10221053 future work can split generic tools from project-specific features when there
10231054 is a concrete consumer need.
1055+
1056+ The public roadmap listing is maintained at
1057+ <https://github.com/users/codegeist-ai/projects/1>. Contributor-sized work should
1058+ start from a GitHub Issue and, when implementation detail needs durable handoff,
1059+ a linked specification under `docs/tasks/`.
1060+
1061+ # # License
1062+
1063+ This repository and its generated runtime release are available under the
1064+ [Zero-Clause BSD (`0BSD`) license](LICENSE).
0 commit comments