diff options
| author | Hyteq <DerpsDer.es@gmail.com> | 2025-06-23 13:37:37 +0300 |
|---|---|---|
| committer | Hyteq <DerpsDer.es@gmail.com> | 2025-06-23 13:37:37 +0300 |
| commit | 0a4d5186a780eb263f97a76b9a413e9fd9ee19c3 (patch) | |
| tree | 4eb8ef057f136a1f46b54efb5952403b8f5a6fd0 /.github/CONTRIBUTING.md | |
| parent | 8ab6d243bb3522347b3d0bb0b2a88359c094cd02 (diff) | |
| download | opencut-0a4d5186a780eb263f97a76b9a413e9fd9ee19c3.tar.gz | |
feat: github templates and db migration
Diffstat (limited to '.github/CONTRIBUTING.md')
| -rw-r--r-- | .github/CONTRIBUTING.md | 65 |
1 files changed, 65 insertions, 0 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 00000000..61ca59ec --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,65 @@ +# 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. Install dependencies: `bun install` +4. Start the development server: `bun run dev` + +## Development Setup + +### Prerequisites +- Node.js 18+ +- 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` +3. Run database migrations: `bun run db:migrate` +4. 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. Write tests for new functionality +4. Ensure all tests pass: `npm test` +5. Run the linter: `npm run lint` +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 `npm run format` before committing +- 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!
\ No newline at end of file |
