Skip to content

CLAUDE.md

Latest commit

 

History

History
48 lines (32 loc) · 3 KB

CLAUDE.md

File metadata and controls

48 lines (32 loc) · 3 KB
Raw

CLAUDE.md

Guidance for Claude Code (and other AI assistants) when working in this repository.

Canonical Instructions

The detailed, authoritative conventions for this project live in .github/copilot-instructions.md; read that file first. This document is a concise map; .github/copilot-instructions.md is the source of truth.

Keep These Two Files in Sync

This repository maintains both CLAUDE.md and .github/copilot-instructions.md. When you update guidance in one file that also applies to the other, mirror the change so the two stay consistent. Updates to CLAUDE.md should be reflected, when appropriate, in .github/copilot-instructions.md, and vice versa.

Project Summary

A template project for creating a TypeScript package for npm.

npm Commands

See the "npm Scripts" section of .github/copilot-instructions.md for the full list of available commands.

Generated Output Directories (not committed)

_dist/ (build), _compiled/ (TypeScript outDir), _coverage/ (coverage), and _doc/ (TypeDoc) are generated and gitignored.

Documentation Notes

  • Keep shared content between README.md and docs/index.md consistent; expected differences (front matter, headings, footer/links) are documented in .github/copilot-instructions.md.
  • The portfolio skills page (docs/portfolio-skills.md) and its generation/review workflow are described in the "Portfolio Page Generation and Maintenance" section of .github/copilot-instructions.md.
  • Release documentation under docs/releases/ is maintained manually.
  • Markdown indentation rules for all repository .md files are in the "Markdown Formatting" section of .github/copilot-instructions.md.

Pre-Merge and Release Review

Before merging a branch, complete these review steps (full details in the "Pre-Merge and Release Review" section of .github/copilot-instructions.md):

  1. Validation — npm ci, then npm run validate (lint, docs, build, test) passes cleanly
  2. Portfolio skills page — review docs/portfolio-skills.md for accuracy; update modified_date if content changes
  3. Instruction file sync — CLAUDE.md and copilot-instructions.md are consistent and current
  4. package.json keywords — reflect current utility domains and features
  5. GitHub repository topics — align with package.json keywords
  6. Branch code review — convention compliance (static class pattern, JSDoc completeness, copyright headers, README/docs sync, test coverage), code quality (correctness, API consistency, efficiency, backward compatibility, reuse/DRY, runtime safety), and consistency (cross-source consistency across code/comments/docs, implicit pattern detection with maintainer notification)
  7. Release readiness (for merges to main) — version bump, release docs, TypeDoc entry points, publish workflow