Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
45 lines (32 loc) · 1.2 KB

CONTRIBUTING.md

File metadata and controls

45 lines (32 loc) · 1.2 KB
Raw

Contributing

Thanks for your interest in contributing to node-spanning.

Development setup

git clone https://github.com/wyre-technology/node-spanning.git
cd node-spanning
npm install
npm test

Quality bar

Before opening a pull request, please make sure:

  • npm test passes
  • npm run typecheck is clean
  • npm run lint is clean
  • npm run build produces dist/ with both CJS and ESM
  • New behavior is covered by tests in tests/
  • No any types in the public surface

Commit messages

This project uses semantic-release, so commit messages must follow the Conventional Commits spec:

  • feat: … — new feature (minor version bump)
  • fix: … — bug fix (patch version bump)
  • docs: …, chore: …, refactor: …, test: … — no version bump
  • feat!: … or BREAKING CHANGE: in the body — major version bump

Pull requests

  • Branch from main
  • Keep PRs focused; one logical change per PR is best
  • Reference any related issue in the PR description

License

By contributing you agree that your contributions will be licensed under the project's Apache-2.0 license.