Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
31 lines (22 loc) · 988 Bytes

CONTRIBUTING.md

File metadata and controls

31 lines (22 loc) · 988 Bytes

Contributing

Thanks for helping improve Hyperstrate.

Development

  1. Fork the repository.
  2. Create a feature branch: git checkout -b feat/my-change.
  3. Make focused changes with tests where behavior changes.
  4. Run the relevant checks:
npm run type-check
npm run lint
npm run test:unit -- --run
npm run build-only
  1. Open a pull request and describe the behavior change, tests, and any API/client-generation impact.

Pull Request Guidelines

  • Keep pull requests focused on one topic.
  • Include tests for bug fixes and behavior changes.
  • Regenerate the API client with npm run codegen after server OpenAPI changes.
  • Do not commit .env, build outputs, TypeScript build info, API keys, Supabase secrets, or provider credentials.
  • Open an issue before large UI, routing, or design-system changes so maintainers can discuss the direction.

Code Style

Follow the existing Vue 3, TypeScript, class-component, Pug, and Tailwind patterns in src/features/.