|
| 1 | +# Contributing to Helix |
| 2 | + |
| 3 | +Thanks for your interest in contributing to Helix! This guide will help you get started. |
| 4 | + |
| 5 | +## Getting Started |
| 6 | + |
| 7 | +1. **Fork** the repository and clone your fork |
| 8 | +2. **Install dependencies:** |
| 9 | + ```bash |
| 10 | + bun install |
| 11 | + ``` |
| 12 | +3. **Set up environment variables:** Copy `.env.example` to `.env` and fill in the required values (see `lib/env.ts` for the full list) |
| 13 | +4. **Set up the database:** |
| 14 | + ```bash |
| 15 | + npm run db:generate |
| 16 | + npm run db:migrate |
| 17 | + ``` |
| 18 | +5. **Start the dev server:** |
| 19 | + ```bash |
| 20 | + npm run dev |
| 21 | + ``` |
| 22 | + |
| 23 | +## Development Workflow |
| 24 | + |
| 25 | +1. Create a new branch from `main`: |
| 26 | + ```bash |
| 27 | + git checkout -b feat/your-feature |
| 28 | + ``` |
| 29 | +2. Make your changes |
| 30 | +3. Run linting and formatting: |
| 31 | + ```bash |
| 32 | + npm run lint |
| 33 | + npm run format |
| 34 | + ``` |
| 35 | +4. Ensure the project builds: |
| 36 | + ```bash |
| 37 | + npm run build |
| 38 | + ``` |
| 39 | +5. Commit your changes and open a pull request |
| 40 | + |
| 41 | +## Code Style |
| 42 | + |
| 43 | +- **Formatting/Linting:** Biome handles all formatting and linting. Run `npm run lint` before committing. |
| 44 | +- **Imports:** Use the `@/` path alias. Use `import type` for type-only imports. |
| 45 | +- **TypeScript:** Strict mode is enabled. Avoid `any`; prefer `unknown` with type guards. |
| 46 | +- **Components:** Use named exports, PascalCase for component names, and `"use client"` only when needed. |
| 47 | +- **CSS:** Use Tailwind utility classes. Merge classNames with `cn()` from `@/lib/utils`. |
| 48 | + |
| 49 | +See `CLAUDE.md` for the full code style guidelines and architecture overview. |
| 50 | + |
| 51 | +## Pull Requests |
| 52 | + |
| 53 | +- Keep PRs focused — one feature or fix per PR |
| 54 | +- Write a clear title and description explaining what changed and why |
| 55 | +- Ensure `npm run build` passes before submitting |
| 56 | +- Link any related issues |
| 57 | + |
| 58 | +## Reporting Bugs |
| 59 | + |
| 60 | +Open an issue with: |
| 61 | +- A clear description of the bug |
| 62 | +- Steps to reproduce |
| 63 | +- Expected vs actual behavior |
| 64 | +- Browser/OS/Node version if relevant |
| 65 | + |
| 66 | +## Suggesting Features |
| 67 | + |
| 68 | +Open an issue describing: |
| 69 | +- The problem you're trying to solve |
| 70 | +- Your proposed solution |
| 71 | +- Any alternatives you've considered |
| 72 | + |
| 73 | +## License |
| 74 | + |
| 75 | +By contributing, you agree that your contributions will be licensed under the [MIT License](LICENSE). |
0 commit comments