Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
46 lines (29 loc) · 1.08 KB

CONTRIBUTING.md

File metadata and controls

46 lines (29 loc) · 1.08 KB

Contributing to @bquery/setup

Thanks for your interest in contributing to @bquery/setup (create-bquery)! This guide explains how to set up the project locally, develop changes, and run tests.

Prerequisites

  • Node.js >=20.0.0
  • npm >=10
  • Git

Setup

  1. Clone the repository.
  2. Install dependencies: npm install

Development

  • Build the CLI: npm run build
  • Watch mode: npm run dev
  • Type-check: npm run typecheck

Tests

  • Run tests: npm test

Build

  • npm run build

Code Style & Quality

  • Run npm run lint before submitting.
  • Follow the existing TypeScript style.
  • Add tests when introducing new generator behaviour or fixing bugs.
  • Update docs/examples when the CLI options or generated output changes.

Pull Requests

  • Describe what and why you changed something.
  • Link relevant issues if available.
  • Use the pull request template and complete the validation checklist.
  • Ensure tests and type-checks pass locally.

Security

Please do not post sensitive details publicly. Report security issues per SECURITY.md.