Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
54 lines (44 loc) · 2.14 KB

CONTRIBUTING.md

File metadata and controls

54 lines (44 loc) · 2.14 KB
Raw

Contributing to this project

Language: 🇬🇧 | 🇯🇵 | 🇨🇳

  1. Please note we have a code of conduct, please follow it in all your interactions with the project.
  2. When contributing to this repository, please first discuss the change you wish to make via Discussions or any other method with the owners of this repository before making a change.
  3. If your idea can be shown with a minor fix, please use directly the pull request.
  4. In this repository, discussion in English or Japanese is recommended.
  5. This project follows Conventional Commits. Please write a user-facing subject line and, in the body, briefly cover why the change is needed, any important context, and what was changed. A suggested .gitmessage template is available at the repository root. See copilot-instructions.md for examples and full details.

Local development tooling

This repository uses a project-local pnpm baseline and Husky hooks so contributors and autopilot runs can enforce the minimum lint gate before commit. Template adopters do not need pnpm — use your project's existing tooling instead (see Tooling boundary).

Requires Node.js ^22.23.2 || ^24.2.0 || >=26.0.0 (this repository's engines floor in package.json).

corepack enable
pnpm install
pnpm run lint
pnpm run test

Node.js 25+ no longer bundles corepack; if corepack enable fails, install it first with npm install -g corepack.

The pre-commit hook runs a fast, commit-safe subset (pnpm run lint:precommit: Biome, dprint, and markdownlint); the full pnpm run lint:minimum suite runs in CI. The commit message hook enforces Conventional Commits through commitlint.

When you edit canonical source files in idd-template/, run pnpm run docs:sync to propagate the changes to all mirrored artifacts.