Skip to content

Add agent/contributor docs, security policy, and GitHub templates - #33

Merged
carlok merged 1 commit into
mainfrom
cursor/repo-governance-docs-8a43
Nov 13, 2026
Merged

carlok merged 1 commit into
mainfrom
cursor/repo-governance-docs-8a43

Conversation

@carlok

@carlok carlok commented Nov 13, 2026

Copy link
Copy Markdown
Owner

Audit verification

Confirmed missing on main before changes:

  • No AGENT.md / AGENTS.md
  • No CONTRIBUTING.md, CODE_OF_CONDUCT.md, or SECURITY.md
  • No .github/ISSUE_TEMPLATE/ or .github/pull_request_template.md

LICENSE (Apache-2.0) unchanged. No product code refactored.

Changes

Area What
AGENT.md Setup (Node 22, npm ci, glslang), CI-aligned commands (npm run check, npm run e2e, etc.), repo layout, conventions. Hard rules: increase/preserve engine coverage before commit, no secrets/host-specific values, keep public docs general; contact @carlok only.
CONTRIBUTING.md Setup, test/coverage expectations (≥90% lines / ≥85% branches on src/engine/**), PR flow, link to SECURITY.md.
CODE_OF_CONDUCT.md Contributor Covenant 2.1; enforcement via GitHub @carlok.
SECURITY.md Report via GitHub Security Advisories; no public issues for vulns.
.github/ISSUE_TEMPLATE/ bug_report.yml, feature_request.yml, config.yml (blank issues off; security + maintainer contact links).
.github/pull_request_template.md Summary + checkboxes for npm run check, npm run e2e, tests, and coverage.
README.md Split npm run check vs npm run e2e (matches .github/workflows/ci.yml); link CONTRIBUTING + AGENT.
docs/DECISIONS.md Point security reporting at SECURITY.md (replaces TBD row).
biome.json Schema URL 2.6.3 → 2.6.4 to match @biomejs/biome 2.6.4 (removes lint info noise).

Commands run locally

Setup

npm ci                                                          # exit 0
sudo apt-get install -y glslang-tools                           # for npm run glsl
npx playwright install chromium                                   # for npm run e2e

npm run check — exit 0

  • npm run lint — 77 files, no fixes
  • npm run typecheck — pass
  • npm run build:legacy — engine/render/audio bundles built
  • npm run glsl — glsl: all checks passed
  • npm run coverage — 24 test files, 66 tests passed; coverage 96.1% lines, 87.05% branches (thresholds met)

npm run e2e — exit 0 with CI=1 (matches CI retries)

  • 25 tests: 24 passed, 1 flaky (the genome panel starts open and remembers being closed, passed on retry)
  • Without CI=1: exit 1 on that same flaky test (first run failed, consistent with Playwright retries: 1 in CI)

Apache-2.0 licence file not modified.

Open in Web Open in Cursor 

Document setup, CI-aligned check/coverage/e2e commands, and reporting
paths for humans and coding agents. Add issue and PR templates, fix README
check vs e2e wording, align Biome schema with CLI 2.6.4, and update
DECISIONS for SECURITY.md.

Co-authored-by: Carlo Perassi <[email protected]>
@carlok
carlok merged commit 96b5d0f into main Nov 13, 2026
5 checks passed
@carlok
carlok deleted the cursor/repo-governance-docs-8a43 branch November 13, 2026 21:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants