Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
39 lines (33 loc) · 683 Bytes

CONTRIBUTING.md

File metadata and controls

39 lines (33 loc) · 683 Bytes

Contributing

Thanks for contributing to create-shape-app.

Requirements

  • Node >=20.18.0
  • Bun 1.3.6+

Setup

bun install

Development Workflow

  1. Create a branch from main.
  2. Make focused changes.
  3. Run validation: 
    bun run lint
bun run type-check
bun run test
  4. Open a pull request with:
    • intent
    • key changes
    • validation commands run

Commit Style

Use conventional commit format:

  • feat(scope): summary
  • fix(scope): summary
  • docs(scope): summary
  • test(scope): summary
  • ci(scope): summary

Local Smoke Check

node ./bin/create-shape-app.js my-app --yes --skip-install --skip-git