File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 1+ # Vibe Coding Guidelines
2+
3+ This repository uses Node.js and TypeScript. Please follow these rules when
4+ contributing:
5+
6+ ## Setup
7+
8+ - Use Node.js version listed in ` .node-version ` .
9+ - Install dependencies with ` npm ci ` .
10+
11+ ## Formatting
12+
13+ - All files are formatted with Prettier.
14+ - Run ` npm run format:write ` before committing. CI will check
15+ ` npm run format:check ` .
16+
17+ ## Linting
18+
19+ - Lint source code with ESLint using ` npm run lint ` .
20+
21+ ## Testing
22+
23+ - Run ` npm test ` (or ` npm run ci-test ` ) to execute Jest tests.
24+ - Add tests for new functionality under ` __test__/ ` .
25+
26+ ## Packaging
27+
28+ - Build distributable files with ` npm run package ` .
29+
30+ ## Pull Requests
31+
32+ - Keep commits concise and use the imperative mood.
33+ - Ensure tests and linting pass before opening a PR.
You can’t perform that action at this time.
0 commit comments