diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index f1b425e4..dbf7a530 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,5 +1,15 @@ # Contributing to OpenCut +⚠️ We are currently NOT accepting feature PRs while we build out the core editor. + +If you want to contribute: + +1. Open an issue first to discuss +2. Wait for maintainer approval +3. Only then start coding + +Critical bug fixes may be accepted on a case-by-case basis. + Thank you for your interest in contributing to OpenCut! This document provides guidelines and instructions for contributing. ## Getting Started diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index b9664c76..c7bdff47 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,50 +1,11 @@ -## Description +⚠️ READ BEFORE SUBMITTING ⚠️ -Please include a summary of the changes and the related issue. Please also include relevant motivation and context. +We are not currently accepting PRs except for critical bugs. -Fixes # (issue) +If this is a bug fix: +- [ ] I've opened an issue first +- [ ] This was approved by a maintainer -## Type of change +If this is a feature: -Please delete options that are not relevant. - -- [ ] Bug fix (non-breaking change which fixes an issue) -- [ ] New feature (non-breaking change which adds functionality) -- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) -- [ ] This change requires a documentation update -- [ ] Performance improvement -- [ ] Code refactoring -- [ ] Tests - -## How Has This Been Tested? - -Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration - -- [ ] Test A -- [ ] Test B - -**Test Configuration**: - -- Node version: -- Browser (if applicable): -- Operating System: - -## Screenshots (if applicable) - -Add screenshots to help explain your changes. - -## Checklist: - -- [ ] My code follows the style guidelines of this project -- [ ] I have performed a self-review of my code -- [ ] I have added screenshots if ui has been changed -- [ ] I have commented my code, particularly in hard-to-understand areas -- [ ] I have made corresponding changes to the documentation -- [ ] My changes generate no new warnings -- [ ] I have added tests that prove my fix is effective or that my feature works -- [ ] New and existing unit tests pass locally with my changes -- [ ] Any dependent changes have been merged and published in downstream modules - -## Additional context - -Add any other context about the pull request here. +This PR will be closed. Please open an issue to discuss first. \ No newline at end of file