Skip to content

Latest commit

 

History

History
49 lines (33 loc) · 961 Bytes

CONTRIBUTING.md

File metadata and controls

49 lines (33 loc) · 961 Bytes

Contributing to SQLoot

Thanks for contributing.

Workflow

  1. Create a feature branch from main
  2. Implement focused, reviewable changes
  3. Run local checks
  4. Open a PR and request review

Local Checks

Use the repository's standard verification command (typically one of):

bun verify
bun run verify

If the repository includes Rust code, also run:

cargo fmt --all
cargo test

Engineering Standards

  • Prefer Bun tooling over npm/pnpm
  • Prefer Biome for formatting/linting where configured
  • Keep TypeScript strict and avoid any unless justified
  • Add/update tests for behavior changes
  • Update docs when behavior or public API changes

Pull Requests

  • Keep PR scope small and explicit
  • Link related issue(s)
  • Document any breaking change
  • Resolve all review comments before merge

Security

For vulnerabilities, do not use public issues. Follow SECURITY.md.

Code of Conduct

See CODE_OF_CONDUCT.md.