Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
43 lines (26 loc) · 1023 Bytes

CONTRIBUTING.md

File metadata and controls

43 lines (26 loc) · 1023 Bytes

Contributing to @bquery/template

Thanks for your interest in contributing to @bquery/template! This guide explains how to set up the project locally, run the dev server, and submit changes.

Prerequisites

  • Node.js >=24.0.0
  • Bun >=1.3.13 (recommended)
  • Git

Setup

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

Development

  • Start the dev server: bun run dev
  • Preview production build: bun run preview

Type-checking

  • bun run typecheck

Build

  • bun run build

Code Style & Quality

  • Run bun run lint before submitting.
  • Keep application logic minimal and focused on demonstrating bQuery patterns.
  • Update docs/comments when changing notable patterns.

Pull Requests

  • Describe what and why you changed something.
  • Use the pull request template and complete the validation checklist.
  • Ensure typecheck and build pass locally.

Security

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