roadmap-skill AGENTS.md

Project Guidelines

Git Commit Messages

All commit messages must be written in English.

Format

Follow Conventional Commits specification:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Types

• feat: A new feature
• fix: A bug fix
• docs: Documentation only changes
• style: Changes that do not affect the meaning of the code (white-space, formatting, etc)
• refactor: A code change that neither fixes a bug nor adds a feature
• perf: A code change that improves performance
• test: Adding missing tests or correcting existing tests
• chore: Changes to the build process or auxiliary tools

Examples

feat: add task priority sorting to kanban board

fix: resolve CI build failure by switching from Taobao registry to npm official registry

docs: update README with installation instructions

refactor(storage): simplify task update logic

Build & Test Commands

# Development
npm run dev              # Start development mode with watch

# Building
npm run build            # Full build (Node + Web)
npm run build:web        # Build only web frontend

# Type checking
npm run typecheck        # Run TypeScript type checking without emitting

# Testing
npm run test             # Run tests in watch mode
npm run test:unit        # Run unit tests once
npm run test:integration # Run integration tests once

# Run a single test file
npx vitest run tests/unit/storage.test.ts

# Run tests matching a pattern
npx vitest run --reporter=verbose --testNamePattern="createProject"

Code Style Guidelines

TypeScript

• Target: ES2022 with NodeNext module resolution
• Strict mode: Enabled - all strict TypeScript options must pass
• Unused code: Not allowed (noUnusedLocals, noUnusedParameters)
• Implicit returns: Not allowed (noImplicitReturns)

Imports & Modules

• Use ES modules ("type": "module" in package.json)
• Include .js extension in imports: import { foo } from './bar.js'
• Prefer named imports over default imports
• Group imports: built-ins → external → internal (separated by blank line)