From aa968cf2c93ea3d309e9ffcf2a4c9f463766a82a Mon Sep 17 00:00:00 2001 From: Adrien Toupet Date: Fri, 5 Dec 2025 13:54:39 -0500 Subject: [PATCH] docs: simplify contribution workflow to main branch only --- CONTRIBUTING.md | 10 ++-------- README.md | 2 +- 2 files changed, 3 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8889e22..8702069 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,15 +16,9 @@ We welcome code contributions from the community. Here's how to propose changes: 1. Fork this repository to your own GitHub account. 2. Create a new branch on your fork for your changes. 3. Make your changes in this branch. -4. When you are ready, submit a pull request to either: - - **`main` branch** - For stable features and bug fixes - - **`nightly` branch** - For experimental features or if you want faster integration (note: this branch changes more frequently and may be less stable) +4. When you are ready, submit a pull request to the **`main`** branch. -### Branch Guidelines -- **Main Branch**: Use this for production-ready changes, critical bug fixes, and well-tested features -- **Nightly Branch**: Use this for experimental features, cutting-edge improvements, or if you need your changes integrated quickly. Be aware that this branch is actively under development and may contain unstable features. - -We use the GitHub Flow workflow. Choose the appropriate target branch based on the nature of your contribution. +We use the GitHub Flow workflow. Before submitting a pull request, please make sure your code adheres to the project's coding conventions and it has passed all tests. If you are adding features, please also add appropriate tests. diff --git a/README.md b/README.md index adceac2..a93bb21 100644 --- a/README.md +++ b/README.md @@ -948,7 +948,7 @@ For detailed contribution guidelines, see [CONTRIBUTING.md](CONTRIBUTING.md). 2. Create your feature branch (`git checkout -b feature/AmazingFeature`) 3. Commit your changes (`git commit -m 'Add some AmazingFeature'`) 4. Push to the branch (`git push origin feature/AmazingFeature`) -5. Open a Pull Request to **main** branch for stable features or **nightly** branch for experimental features +5. Open a Pull Request to the **main** branch **Get Help:** - YouTube: [AInVFX Channel](https://www.youtube.com/@AInVFX)