Skip to content

Add AGENTS guidelines #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add AGENTS guidelines #32

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.