Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
38 lines (28 loc) · 1 KB

CONTRIBUTING.md

File metadata and controls

38 lines (28 loc) · 1 KB

Contributing

Contributions are welcome! Here's how to get started.

Setup

git clone https://github.com/ofershap/cursor-plan-preview.git
cd cursor-plan-preview
npm install

Development

npm run build        # Build CLI + UI
npm run dev:ui       # UI dev server with hot reload
npm run typecheck    # Type-check with tsc
npm test             # Run tests
npm run lint         # Lint + format check
npm run format       # Auto-format with Prettier

Pull Requests

  1. Fork the repo and create a branch from main
  2. Make your changes
  3. Add or update tests as needed
  4. Ensure npm run lint, npm run typecheck, and npm test all pass
  5. Open a pull request

Commit Messages

This project uses Conventional Commits and semantic-release for automated versioning:

  • feat: add new feature — minor release
  • fix: resolve bug — patch release
  • feat!: breaking change — major release