diff options
Diffstat (limited to '.github')
| -rw-r--r-- | .github/CODE_OF_CONDUCT.md | 20 | ||||
| -rw-r--r-- | .github/CONTRIBUTING.md | 4 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/bug_report.yml | 6 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/feature_request.yml | 4 | ||||
| -rw-r--r-- | .github/SECURITY.md | 2 | ||||
| -rw-r--r-- | .github/SUPPORT.md | 6 | ||||
| -rw-r--r-- | .github/copilot-instructions.md | 23 | ||||
| -rw-r--r-- | .github/pull_request_template.md | 9 | ||||
| -rw-r--r-- | .github/workflows/bun-ci.yml | 4 |
9 files changed, 48 insertions, 30 deletions
diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md index b6d67872..2661e182 100644 --- a/.github/CODE_OF_CONDUCT.md +++ b/.github/CODE_OF_CONDUCT.md @@ -17,23 +17,23 @@ diverse, inclusive, and healthy community. 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, +- 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 +- 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 +- 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, +- 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 +- Other conduct which could reasonably be considered inappropriate in a professional setting ## Enforcement Responsibilities diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 75c4120b..f1b425e4 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -98,11 +98,11 @@ If you're unsure whether your idea falls into the preview category, feel free to ```bash # Database (matches docker-compose.yaml) - DATABASE_URL="postgresql://opencut:opencutthegoat@localhost:5432/opencut" + DATABASE_URL="postgresql://opencut:opencut@localhost:5432/opencut" # Generate a secure secret for Better Auth BETTER_AUTH_SECRET="your-generated-secret-here" - NEXT_PUBLIC_BETTER_AUTH_URL="http://localhost:3000" + NEXT_PUBLIC_SITE_URL="http://localhost:3000" # Redis (matches docker-compose.yaml) UPSTASH_REDIS_REST_URL="http://localhost:8079" diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index c9684d1f..01965d41 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,6 +1,6 @@ name: Bug report description: Create a report to help us improve -title: '[BUG] ' +title: "[BUG] " labels: bug body: - type: input @@ -15,7 +15,7 @@ body: id: Browser attributes: label: Browser - description: Please enter the browser on which you encountered the bug. + description: Please enter the browser on which you encountered the bug. placeholder: e.g. Chrome 137, Firefox 137, Safari 17 validations: required: true @@ -67,4 +67,4 @@ body: Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. validations: - required: false
\ No newline at end of file + required: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 49a00eb6..336e2d6a 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -1,6 +1,6 @@ name: Feature request description: Suggest an idea for OpenCut -title: '[FEATURE] ' +title: "[FEATURE] " labels: enhancement body: - type: markdown @@ -39,4 +39,4 @@ body: Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. validations: - required: false
\ No newline at end of file + required: false diff --git a/.github/SECURITY.md b/.github/SECURITY.md index f6d94c5e..1369bbab 100644 --- a/.github/SECURITY.md +++ b/.github/SECURITY.md @@ -25,4 +25,4 @@ Please do not report security vulnerabilities through public GitHub issues. - 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 +Thank you for helping keep OpenCut secure! diff --git a/.github/SUPPORT.md b/.github/SUPPORT.md index 892a0f7a..1df3d7bd 100644 --- a/.github/SUPPORT.md +++ b/.github/SUPPORT.md @@ -3,21 +3,25 @@ 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 +We appreciate your patience and contributions to making OpenCut better! diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 5d6e71f2..77e361d1 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -3,15 +3,18 @@ applyTo: "**/*.{ts,tsx,js,jsx}" --- # Project Context + Ultracite enforces strict type safety, accessibility standards, and consistent code quality for JavaScript/TypeScript projects using Biome's lightning-fast formatter and linter. ## Key Principles + - Zero configuration required - Subsecond performance - Maximum type safety - AI-friendly code generation ## Before Writing Code + 1. Analyze existing patterns in the codebase 2. Consider edge cases and error scenarios 3. Follow the rules below strictly @@ -20,6 +23,7 @@ Ultracite enforces strict type safety, accessibility standards, and consistent c ## Rules ### Accessibility (a11y) + - Don't use `accessKey` attribute on any HTML element. - Don't set `aria-hidden="true"` on focusable elements. - Don't add ARIA roles, states, and properties to elements that don't support them. @@ -56,6 +60,7 @@ Ultracite enforces strict type safety, accessibility standards, and consistent c - Use correct ISO language/country codes for the `lang` attribute. ### Code Complexity and Quality + - Don't use consecutive spaces in regular expression literals. - Don't use the `arguments` object. - Don't use primitive type aliases or misleading types. @@ -111,6 +116,7 @@ Ultracite enforces strict type safety, accessibility standards, and consistent c - Don't use literal numbers that lose precision. ### React and JSX Best Practices + - Don't use the return value of React.render. - Make sure all dependencies are correctly specified in React hooks. - Make sure all React hooks are called from the top level of component functions. @@ -129,6 +135,7 @@ Ultracite enforces strict type safety, accessibility standards, and consistent c - Watch out for possible "wrong" semicolons inside JSX elements. ### Correctness and Safety + - Don't assign a value to itself. - Don't return a value from a setter. - Don't compare expressions that modify string case with non-compliant values. @@ -153,7 +160,7 @@ Ultracite enforces strict type safety, accessibility standards, and consistent c - Don't use bitwise operators. - Don't use expressions where the operation doesn't change the value. - Make sure Promise-like statements are handled appropriately. -- Don't use __dirname and __filename in the global scope. +- Don't use **dirname and **filename in the global scope. - Prevent import cycles. - Don't use configured elements. - Don't hardcode sensitive data like API keys and tokens. @@ -184,6 +191,7 @@ Ultracite enforces strict type safety, accessibility standards, and consistent c - Don't use `target="_blank"` without `rel="noopener"`. ### TypeScript Best Practices + - Don't use TypeScript enums. - Don't export imported variables. - Don't add type annotations to variables, parameters, and class properties that are initialized with literal expressions. @@ -208,6 +216,7 @@ Ultracite enforces strict type safety, accessibility standards, and consistent c - Use the namespace keyword instead of the module keyword to declare TypeScript namespaces. ### Style and Consistency + - Don't use global `eval()`. - Don't use callbacks in asynchronous tests and hooks. - Don't use negation in `if` statements that have `else` clauses. @@ -295,30 +304,34 @@ Ultracite enforces strict type safety, accessibility standards, and consistent c - Make sure to use the "use strict" directive in script files. ### Next.js Specific Rules + - Don't use `<img>` elements in Next.js projects. - Don't use `<head>` elements in Next.js projects. -- Don't import next/document outside of pages/_document.jsx in Next.js projects. -- Don't use the next/head module in pages/_document.js on Next.js projects. +- Don't import next/document outside of pages/\_document.jsx in Next.js projects. +- Don't use the next/head module in pages/\_document.js on Next.js projects. ### Testing Best Practices + - Don't use export or module.exports in test files. - Don't use focused tests. - Make sure the assertion function, like expect, is placed inside an it() function call. - Don't use disabled tests. ## Common Tasks + - `npx ultracite init` - Initialize Ultracite in your project - `npx ultracite format` - Format and fix code automatically - `npx ultracite lint` - Check for issues without fixing ## Example: Error Handling + ```typescript // ✅ Good: Comprehensive error handling try { const result = await fetchData(); return { success: true, data: result }; } catch (error) { - console.error('API call failed:', error); + console.error("API call failed:", error); return { success: false, error: error.message }; } @@ -328,4 +341,4 @@ try { } catch (e) { console.log(e); } -```
\ No newline at end of file +``` diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index b7686c4b..b9664c76 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -24,9 +24,10 @@ Please describe the tests that you ran to verify your changes. Provide instructi - [ ] Test B **Test Configuration**: -* Node version: -* Browser (if applicable): -* Operating System: + +- Node version: +- Browser (if applicable): +- Operating System: ## Screenshots (if applicable) @@ -46,4 +47,4 @@ Add screenshots to help explain your changes. ## Additional context -Add any other context about the pull request here. +Add any other context about the pull request here. diff --git a/.github/workflows/bun-ci.yml b/.github/workflows/bun-ci.yml index f01b9878..d3e4dcb7 100644 --- a/.github/workflows/bun-ci.yml +++ b/.github/workflows/bun-ci.yml @@ -22,9 +22,9 @@ jobs: os: [ubuntu-latest, windows-latest, macos-latest] env: - DATABASE_URL: "postgresql://opencut:opencutthegoat@localhost:5432/opencut" + DATABASE_URL: "postgresql://opencut:opencut@localhost:5432/opencut" BETTER_AUTH_SECRET: "supersecret" - NEXT_PUBLIC_BETTER_AUTH_URL: "http://localhost:3000" + NEXT_PUBLIC_SITE_URL: "http://localhost:3000" UPSTASH_REDIS_REST_URL: "https://your-upstash-redis-url" UPSTASH_REDIS_REST_TOKEN: "your-upstash-redis-token" |