fix: package json commands
This commit is contained in:
21
.github/CONTRIBUTING.md
vendored
21
.github/CONTRIBUTING.md
vendored
@ -6,8 +6,9 @@ Thank you for your interest in contributing to OpenCut! This document provides g
|
|||||||
|
|
||||||
1. Fork the repository
|
1. Fork the repository
|
||||||
2. Clone your fork locally
|
2. Clone your fork locally
|
||||||
3. Install dependencies: `bun install`
|
3. Navigate to the web app directory: `cd apps/web`
|
||||||
4. Start the development server: `bun run dev`
|
4. Install dependencies: `bun install`
|
||||||
|
5. Start the development server: `bun run dev`
|
||||||
|
|
||||||
## Development Setup
|
## Development Setup
|
||||||
|
|
||||||
@ -18,9 +19,10 @@ Thank you for your interest in contributing to OpenCut! This document provides g
|
|||||||
|
|
||||||
### Local Development
|
### Local Development
|
||||||
1. Copy `.env.example` to `.env.local` and configure your environment variables
|
1. Copy `.env.example` to `.env.local` and configure your environment variables
|
||||||
2. Start the database: `docker-compose up -d`
|
2. Start the database: `docker-compose up -d` (run from project root)
|
||||||
3. Run database migrations: `bun run db:migrate`
|
3. Navigate to the web app: `cd apps/web`
|
||||||
4. Start the development server: `bun run dev`
|
4. Run database migrations: `bun run db:migrate`
|
||||||
|
5. Start the development server: `bun run dev`
|
||||||
|
|
||||||
## How to Contribute
|
## How to Contribute
|
||||||
|
|
||||||
@ -37,16 +39,17 @@ Thank you for your interest in contributing to OpenCut! This document provides g
|
|||||||
### Code Contributions
|
### Code Contributions
|
||||||
1. Create a new branch: `git checkout -b feature/your-feature-name`
|
1. Create a new branch: `git checkout -b feature/your-feature-name`
|
||||||
2. Make your changes
|
2. Make your changes
|
||||||
3. Write tests for new functionality
|
3. Navigate to the web app directory: `cd apps/web`
|
||||||
4. Ensure all tests pass: `bun test`
|
4. Run the linter: `bun run lint`
|
||||||
5. Run the linter: `bun run lint`
|
5. Format your code: `bunx biome format --write .`
|
||||||
6. Commit your changes with a descriptive message
|
6. Commit your changes with a descriptive message
|
||||||
7. Push to your fork and create a pull request
|
7. Push to your fork and create a pull request
|
||||||
|
|
||||||
## Code Style
|
## Code Style
|
||||||
|
|
||||||
- We use Biome for code formatting and linting
|
- We use Biome for code formatting and linting
|
||||||
- Run `bun run format` before committing
|
- Run `bunx biome format --write .` from the `apps/web` directory to format code
|
||||||
|
- Run `bun run lint` from the `apps/web` directory to check for linting issues
|
||||||
- Follow the existing code patterns
|
- Follow the existing code patterns
|
||||||
|
|
||||||
## Pull Request Process
|
## Pull Request Process
|
||||||
|
Reference in New Issue
Block a user