diff options
| -rw-r--r-- | .github/CODE_OF_CONDUCT.md | 90 | ||||
| -rw-r--r-- | .github/CONTRIBUTING.md | 65 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/bug_report.md | 31 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/feature_request.md | 19 | ||||
| -rw-r--r-- | .github/SECURITY.md | 28 | ||||
| -rw-r--r-- | .github/SUPPORT.md | 23 |
6 files changed, 256 insertions, 0 deletions
diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..b7277d26 --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,90 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall + community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or advances of + any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email address, + without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +[INSERT CONTACT METHOD]. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
\ No newline at end of file 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 diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..85cc4b23 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,31 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '[BUG] ' +labels: bug +assignees: '' +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Additional context** +Add any other context about the problem here.
\ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..1d528f25 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,19 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '[FEATURE] ' +labels: enhancement +assignees: '' +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here.
\ No newline at end of file diff --git a/.github/SECURITY.md b/.github/SECURITY.md new file mode 100644 index 00000000..5d3459de --- /dev/null +++ b/.github/SECURITY.md @@ -0,0 +1,28 @@ +# Security Policy + +## Supported Versions + +| Version | Supported | +| ------- | ------------------ | +| 1.x.x | :white_check_mark: | + +## Reporting a Vulnerability + +We take security vulnerabilities seriously. If you discover a security vulnerability within OpenCut, please send an email to security@opencut.dev. All security vulnerabilities will be promptly addressed. + +Please do not report security vulnerabilities through public GitHub issues. + +### What to include in your report + +- Description of the vulnerability +- Steps to reproduce +- Potential impact +- Any suggested fixes + +### Response timeline + +- We will acknowledge receipt within 48 hours +- We will provide a detailed response within 5 business days +- We will keep you updated on our progress + +Thank you for helping keep OpenCut secure!
\ No newline at end of file diff --git a/.github/SUPPORT.md b/.github/SUPPORT.md new file mode 100644 index 00000000..892a0f7a --- /dev/null +++ b/.github/SUPPORT.md @@ -0,0 +1,23 @@ +# Getting Help + +Thanks for using OpenCut! If you need help, here are your options: + +## Documentation +- Check our [README](../README.md) for basic setup instructions +- Review the [Contributing Guidelines](CONTRIBUTING.md) for development setup + +## Issues +- **Bug reports**: Use the bug report template +- **Feature requests**: Use the feature request template +- **Questions**: Use GitHub Discussions for general questions + +## Community +- Join our discussions on GitHub +- Follow the [Code of Conduct](CODE_OF_CONDUCT.md) + +## Response Times +- Issues are typically triaged within 2-3 business days +- Feature requests may take longer to evaluate +- Security issues are handled with priority + +We appreciate your patience and contributions to making OpenCut better!
\ No newline at end of file |