chore: add project standards (AGENTS.md, CI, devlog, e2e scaffold) - #10
Merged
Conversation
…affold) Bring billion-context-opencode to opencode-acp's contributing standard: - AGENTS.md (~436 lines): MIT monorepo dev spec. Documents the dual-shape mechanism (Object.assign + Plugin.define identity), @bili/core private workspace, call<->result pairing invariant, splice-in-place reassembly, per-session lock contract, gh-guard note, git-safety rules, and the absolute PR-merge prohibition (human-only). - .github/workflows/ci.yml: matrix Node 22/24, typecheck+build+test (job 'build') - .github/workflows/pr-checks.yml: runs check-pr.sh (job 'pr-validation') - .github/workflows/release.yml: release-branch merge -> tag + publish ONLY billion-context-opencode (--workspace) + GitHub Release; prerelease (-suffix) -> npm dev tag; workflow_dispatch force override - scripts/ci/check-pr.sh: branch regex, devlog presence, changelog-on-bump - devlog/: README + REQ/WORKLOG/DESIGN templates + this task's entry - scripts/e2e/: README (planned Docker harness) + run-e2e.sh stub - README.md: append Changelog section (### v0.1.0 baseline) Verified: check-pr.sh passes on this branch, typecheck clean, yaml parses.
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.
What
Add project standards to
billion-context-opencode, bringing it to the same contributing standard asopencode-acp(adapted for this MIT monorepo with a single published package).Files
AGENTS.md(~436 lines)Object.assign(v1Fn, {id, setup})+ whyPlugin.defineidentity makes one package serve V1+V2),@bili/coreprivate workspace, call↔result pairing invariant, splice-in-place reassembly, per-session lock contract, gh-guard note, git-safety table, and the absolute PR-merge prohibition (human-only)..github/workflows/ci.ymlnpm ci→ typecheck → build → test. Job namedbuildso branch protection can require it..github/workflows/pr-checks.ymlscripts/ci/check-pr.sh(branch regex, devlog, changelog-on-bump). Job namedpr-validation..github/workflows/release.ymlYYYY-MM-DD_release-v*, standard + squash patterns) → tagv{VERSION}→npm publish --workspace billion-context-opencode→ GitHub Release. Prerelease (-suffix) → npmdevtag.workflow_dispatch(force)override. Publishes only the public package.scripts/ci/check-pr.sh^\d{4}-\d{2}-\d{2}_[a-z0-9.-]+$, devlogREQ.md+WORKLOG.mdexistence, changelog entry whenpackages/billion-context-opencode/package.jsonversion bumps.devlog/{README,REQ.template,WORKLOG.template,DESIGN.template}.mddevlog/2026-08-13_project-standards/{REQ,WORKLOG}.mdscripts/e2e/{README.md,run-e2e.sh}README.md## Changelogwith### v0.1.0baseline entry (existing content preserved).Adaptations vs opencode-acp
npm run typecheck --workspaces, build/test target thebillion-context-opencodeworkspace.--workspace billion-context-opencodeonly;@bili/coreis private (never published).master(renamed frommain).README.zh-CN.mdchangelog check.packages/billion-context-opencode/package.json(not root).Verification
bash scripts/ci/check-pr.sh 2026-08-13_project-standards origin/master→ PASS ✅npm run typecheck --workspaces→ clean ✅ (no source touched)bash -n scripts/ci/check-pr.sh→ syntax valid ✅python3 -m yaml) → all 3 workflows parse ✅git status→ onlyREADME.mdmodified + newAGENTS.md/.github//devlog//scripts/— nopackages/changesNotes
NPM_TOKENsecret still needs to be added to repo settings forrelease.ymlto publish (documented in AGENTS.md §5.4.3).enforce_admins: false); should additionally require thebuildandpr-validationchecks.