Repository Guidelines

Project Structure & Module Organization

Core extension code lives in
```
src/
```
, entry point at
```
src/extension.ts
```
.
Services and IoC helpers are split across
```
container/
```
,
```
factories/
```
,
```
interfaces/
```
,
```
storage/
```
, and
```
config/
```
to keep dependencies explicit.

View providers such as

BranchTreeViewProvider.ts

and

IndexHistoryProvider.ts

reside under

src/views

Tests live in
```
src/test/
```
(unit, integration, host). Bundled output is written to
```
out/
```
, and production artifacts to
```
dist/
```
. Assets and docs sit in
```
assets/
```
and
```
docs/
```
.

Build, Test, and Development Commands

```
pnpm run compile
```
— webpack build for local development.
```
pnpm run watch
```
— rebuild on file changes.
```
pnpm run package
```
— production bundle with hidden source maps.
```
pnpm run lint
```
— run ESLint on
```
src/
```
.

pnpm test

pnpm run test:headless

pnpm run test:local

pnpm run test:unit

— execute VS Code or TS-only test suites as required.

Coding Style & Naming Conventions

TypeScript strict mode, 2-space indent, semicolons required; Prettier enforces formatting.
ESLint rules in
```
eslint.config.mjs
```
; run
```
pnpm run lint -- --fix
```
for quick cleanups.
Use descriptive PascalCase for classes, camelCase for functions, and CONSTANT_CASE for configuration keys.
Group imports by module type as detailed in
```
GEMINI.md
```
; avoid default exports unless the module exports a single concern.

Testing Guidelines

Prefer TS-based unit tests with
```
tsx
```
, colocated under
```
src/test/unit
```
.
Integration and VS Code host tests belong in
```
src/test/integration
```
and
```
src/test/suite
```
.
Name specs with
```
.test.ts
```
; structure suite names to reflect feature and scenario (
```
describe('StorageService -> encrypt()')
```
).
Aim to cover error handling, telemetry, and file I/O edge cases; consult
```
GEMINI.md
```
for required fixtures.

Commit & Pull Request Guidelines

Use Conventional Commits (

feat(storage): add GitHub provider

fix(config): handle missing key

Every PR should describe the change, link related issues, and document verification steps; attach screenshots or GIFs when UI changes occur.
Update
```
README.md
```
and
```
CHANGELOG.md
```
when altering commands, settings, or user-visible behavior.

Security & Configuration Tips

Never commit secrets;
```
.secureNotes/
```
holds runtime-only data.
Review
```
GEMINI.md
```
for secure key handling and configuration schema expectations.
Validate that new configuration entries include schema docs and default fallbacks.

Project Structure & Module Organization

Core extension code lives in

src/

, entry point at

src/extension.ts

Services and IoC helpers are split across

container/

factories/

interfaces/

storage/

, and

config/

to keep dependencies explicit.

View providers such as

BranchTreeViewProvider.ts

and

IndexHistoryProvider.ts

reside under

src/views

Tests live in

src/test/

(unit, integration, host). Bundled output is written to

out/

, and production artifacts to

dist/

. Assets and docs sit in

assets/

and

docs/

Build, Test, and Development Commands

pnpm run compile

— webpack build for local development.

pnpm run watch

— rebuild on file changes.

pnpm run package

— production bundle with hidden source maps.

pnpm run lint

— run ESLint on

src/

pnpm test

pnpm run test:headless

pnpm run test:local

pnpm run test:unit

— execute VS Code or TS-only test suites as required.

Coding Style & Naming Conventions

TypeScript strict mode, 2-space indent, semicolons required; Prettier enforces formatting.

ESLint rules in

eslint.config.mjs

; run

pnpm run lint -- --fix

for quick cleanups.

Use descriptive PascalCase for classes, camelCase for functions, and CONSTANT_CASE for configuration keys.

Group imports by module type as detailed in

GEMINI.md

; avoid default exports unless the module exports a single concern.

Testing Guidelines

Prefer TS-based unit tests with

tsx

, colocated under

src/test/unit

Integration and VS Code host tests belong in

src/test/integration

and

src/test/suite

Name specs with

.test.ts

; structure suite names to reflect feature and scenario (

describe('StorageService -> encrypt()')

Aim to cover error handling, telemetry, and file I/O edge cases; consult

GEMINI.md

for required fixtures.

Commit & Pull Request Guidelines

Use Conventional Commits (

feat(storage): add GitHub provider

fix(config): handle missing key

Every PR should describe the change, link related issues, and document verification steps; attach screenshots or GIFs when UI changes occur.

Update

README.md

and

CHANGELOG.md

when altering commands, settings, or user-visible behavior.

Repository Guidelines

Repository Guidelines

Project Structure & Module Organization

Build, Test, and Development Commands

Coding Style & Naming Conventions

Testing Guidelines

Commit & Pull Request Guidelines

Security & Configuration Tips

Related Skills

Nano Banana Pro

Markdown Converter

1password

Repository Guidelines

Project Structure & Module Organization

Build, Test, and Development Commands

Coding Style & Naming Conventions

Testing Guidelines

Commit & Pull Request Guidelines

Security & Configuration Tips