69 lines
1.9 KiB
Markdown
69 lines
1.9 KiB
Markdown
# Contributing to OpenCut
|
|
|
|
Thank you for your interest in contributing to OpenCut! This document provides guidelines and instructions for contributing.
|
|
|
|
## Getting Started
|
|
|
|
1. Fork the repository
|
|
2. Clone your fork locally
|
|
3. Navigate to the web app directory: `cd apps/web`
|
|
4. Install dependencies: `bun install`
|
|
5. Start the development server: `bun run dev`
|
|
|
|
## Development Setup
|
|
|
|
### Prerequisites
|
|
- Node.js 18+
|
|
- Bun (latest version)
|
|
- Docker (for local database)
|
|
|
|
### Local Development
|
|
1. Copy `.env.example` to `.env.local` and configure your environment variables
|
|
2. Start the database: `docker-compose up -d` (run from project root)
|
|
3. Navigate to the web app: `cd apps/web`
|
|
4. Run database migrations: `bun run db:migrate`
|
|
5. Start the development server: `bun run dev`
|
|
|
|
## How to Contribute
|
|
|
|
### Reporting Bugs
|
|
- Use the bug report template
|
|
- Include steps to reproduce
|
|
- Provide screenshots if applicable
|
|
|
|
### Suggesting Features
|
|
- Use the feature request template
|
|
- Explain the use case
|
|
- Consider implementation details
|
|
|
|
### Code Contributions
|
|
1. Create a new branch: `git checkout -b feature/your-feature-name`
|
|
2. Make your changes
|
|
3. Navigate to the web app directory: `cd apps/web`
|
|
4. Run the linter: `bun run lint`
|
|
5. Format your code: `bunx biome format --write .`
|
|
6. Commit your changes with a descriptive message
|
|
7. Push to your fork and create a pull request
|
|
|
|
## Code Style
|
|
|
|
- We use Biome for code formatting and linting
|
|
- 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
|
|
|
|
## Pull Request Process
|
|
|
|
1. Fill out the pull request template completely
|
|
2. Link any related issues
|
|
3. Ensure CI passes
|
|
4. Request review from maintainers
|
|
5. Address any feedback
|
|
|
|
## Community
|
|
|
|
- Be respectful and inclusive
|
|
- Follow our Code of Conduct
|
|
- Help others in discussions and issues
|
|
|
|
Thank you for contributing! |