From ec95ede54dd1498b97839ad326b95068e8b788d8 Mon Sep 17 00:00:00 2001 From: Kohki Miki Date: Tue, 20 May 2025 22:15:56 +0900 Subject: [PATCH] docs: add contribution guidelines --- AGENTS.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 AGENTS.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..0b46fd3 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,33 @@ +# Vibe Coding Guidelines + +This repository uses Node.js and TypeScript. Please follow these rules when +contributing: + +## Setup + +- Use Node.js version listed in `.node-version`. +- Install dependencies with `npm ci`. + +## Formatting + +- All files are formatted with Prettier. +- Run `npm run format:write` before committing. CI will check + `npm run format:check`. + +## Linting + +- Lint source code with ESLint using `npm run lint`. + +## Testing + +- Run `npm test` (or `npm run ci-test`) to execute Jest tests. +- Add tests for new functionality under `__test__/`. + +## Packaging + +- Build distributable files with `npm run package`. + +## Pull Requests + +- Keep commits concise and use the imperative mood. +- Ensure tests and linting pass before opening a PR.