Imported from vrognas/vrognas-redmyne (AGENTS.md). Install upstream with npx skills add vrognas/vrognas-redmyne. Copyright stays with the author.

Repository Guidelines

Name: vrognas-redmyne
Author: vrognas

Project Structure & Module Organization

src/ contains the extension source (TypeScript). Entry point is src/extension.ts, with feature areas under src/commands/, src/controllers/, src/redmine/, src/trees/, src/kanban/, src/draft-mode/, and src/webviews/.
test/ hosts Vitest suites: unit tests in test/unit/, integration tests in test/integration/, and supporting fixtures/mocks in test/fixtures/ and test/mocks/.
media/ holds walkthrough content and assets used by the extension UI.
docs/ contains architecture notes, API references, and performance guidance.
Build output lands in out/ (generated by esbuild.cjs).

npm install installs dependencies and git hooks (scripts/install-hooks.sh).
npm run compile builds the extension into out/ (production build).
npm run watch runs the incremental build for local dev.
npm run lint checks code style with ESLint.
npm run typecheck runs tsc --noEmit.
npm test runs the Vitest suite once; npm run test:watch keeps it running.
npm run test:coverage runs tests with coverage; npm run ci runs lint + typecheck + coverage.
npm run package builds a VSIX package.
npm run create-test-issues seeds Redmine with test data for manual workflows.

Formatting is enforced by Prettier (tabWidth: 2, semicolons, trailing commas, LF line endings).
Linting is enforced by ESLint (npm run lint).
Use descriptive, feature-based filenames consistent with existing modules (e.g., kanban-controller.ts, redmine-server.ts).

Framework: Vitest (vitest.config.ts).
Naming convention: *.test.ts under test/unit/ or test/integration/.
Add new tests near the related feature area and prefer unit coverage for utilities.

Commits follow Conventional Commits: type: description with an imperative, no-trailing-period subject (e.g., feat: …, fix: …, refactor: …, docs: …, test: …, chore: …).
Commit messages are validated by scripts/commit-msg (mirrored in CI by scripts/validate-commits.sh): subject ≤ 50 chars, body lines ≤ 72 chars, blank line between subject/body.
CONTRIBUTING expects Type: description with types like Add, Fix, Feat, Chore, Docs, Test, Refactor, Revert.
PRs should be small and focused; add a [Unreleased] entry to CHANGELOG.md for user-facing changes and discuss new features in GitHub Discussions first.

The extension requires HTTPS and stores API keys in the OS keychain.
When debugging API issues, use Redmine: Show API Output and include sanitized logs in issues.