Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
64 lines (40 loc) · 1.32 KB

CONTRIBUTING.md

File metadata and controls

64 lines (40 loc) · 1.32 KB
Raw

Contributing

Setup

git clone https://github.com/webdeveric/utils.git
cd utils
corepack enable
pnpm install --frozen-lockfile

Node.js version

This project uses the Node version in .node-version.

Run fnm use or nvm use to ensure you're using the correct Node.js version.

Testing

Run tests in watch mode

pnpm test

Run tests and generate a coverage report.

pnpm coverage

Linting, type checking, and spell checking

These all run in CI and must pass before a PR can be merged.

pnpm lint
pnpm typecheck
pnpm spellcheck

Run pnpm format to apply Prettier formatting. A pre-commit hook auto-fixes lint/format/spelling issues on staged files, so most of this happens for you on commit.

Building

pnpm build

Commit messages

Commit messages should follow conventional commits.

Releases are created automatically and the version bump is determined from the commit messages.

Pull requests

If you want to add a large feature or breaking change, please open an issue first so it can be discussed.

⚠️ Low effort AI generated PRs will be closed without any explanation.

Security

To report a security vulnerability, see SECURITY.md instead of opening a public issue.