Project Instructions — Q-Edit

Last updated: 2025-09-02

Purpose & Scope

Q-Edit is a static, single-page web app for browsing and managing content artifacts. This repository favors a zero-build setup (pure HTML/CSS/JS) with a small Node toolchain for linting, formatting, testing, and CI.

Environment & Commands

Node 20+ recommended.
Install: npm install
Dev server: npm run serve → http://localhost:5173
Lint/Format: npm run lint / npm run format
Tests: npm test (coverage via v8)
Audits: npm run docs:audit & npm run tests:audit

CI Provider & Workflow

Gitea Actions under .gitea/workflows/ci.yml:
- Install Node (official tarball)
- npm ci (or npm install first run)
- Lint → Build (noop) → Tests (coverage)
- Archive coverage artifacts

Collaboration Checklist

Small, atomic PRs with linked issues.
Update docs & tests alongside code changes.
Add ADRs for noteworthy decisions under docs/adr/.
Keep zero ESLint errors and maintain coverage thresholds.

Contribution Flow

Create a branch off main.
Make focused changes with tests.
Update docs/ADRs.
Run npm run lint, npm test, audits.
Open PR; include summary + verification steps.

Living Memory

Capture ongoing insights in docs/memory/ (optional). Promote enduring items into the Coding Instructions or ADRs.

1.3 KiB Raw Permalink Blame History