Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
55 lines (39 loc) · 1.49 KB

CONTRIBUTING.md

File metadata and controls

55 lines (39 loc) · 1.49 KB
Raw

Contributing to @danmat/query-server

Thanks for your interest in contributing! This project is part of the @danmat HTTP QUERY suite.

Development setup

Requires Node.js 18+ (CI tests 18, 20, 22).

git clone https://github.com/DanMat/query-server.git
cd query-server
npm install

Common tasks:

npm test         # run the test suite (vitest)
npm run build    # bundle with tsup (ESM + CJS + types)
npm run typecheck
npm run lint     # Biome: lint + format check
npm run format   # Biome: apply safe fixes

Before you open a pull request

  • Add or update tests for your change.
  • Make sure npm run lint, npm run typecheck, and npm test all pass.
  • A pre-commit hook runs lint-staged (Biome) automatically; please don't skip it.
  • Keep the public API small — its only runtime dependency is @danmat/accept-query.

Commit & PR

  • Use clear, imperative commit messages.
  • Open the PR against main; CI must be green before review.
  • Describe the motivation and any tradeoffs.

Releasing (maintainers)

Releases are automated. Bump the version, tag it, and push:

npm version patch --no-git-tag-version
git commit -am "release: vX.Y.Z"
git tag vX.Y.Z && git push origin main --tags

The Release workflow runs lint + typecheck + tests, then publishes to npm with provenance.

Code of Conduct

By participating you agree to abide by our Code of Conduct.