From 22845e8d410235f8d16e326b646e6477b6110a6a Mon Sep 17 00:00:00 2001 From: PhilReact Date: Mon, 21 Apr 2025 14:39:23 +0300 Subject: [PATCH 1/3] update readme --- README.md | 83 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 83 insertions(+) diff --git a/README.md b/README.md index 25f4e90..001c6e9 100644 --- a/README.md +++ b/README.md @@ -19,3 +19,86 @@ Leveraging a redundant set of publicly accessible nodes provided by crowetic, Qo Many additional details and a fully featured wiki will be created over time. Reach out on the chat on https://qortal.dev or in any of the community locations for Qortal, if you have any issues. Thank you! +# 🤝 Contributing Guide + +Thank you for your interest in contributing! We follow a structured Git workflow to keep the project clean, stable, and production-ready at all times. + +--- + +## 📦 Branch Overview + +| Branch | Purpose | +|------------------|----------------------------------------------------------| +| `master` | Stable, production-ready code. All releases are tagged here. | +| `develop` | Active development branch. All new features go here first. | +| `release/x.y.z` | Pre-release branch for staging, QA, and final polish. | + +--- + +## 🌿 Creating a Feature or Fix + +1. **Start from `develop`:** + + ```bash + git checkout develop + git checkout -b feature/your-feature-name + ``` + +2. **Make your changes and commit them.** + +3. **Push your branch:** + + ```bash + git push origin feature/your-feature-name + ``` + +4. **Open a Pull Request into `develop`.** + +--- + +## 🚀 Releasing Code (Maintainers Only) + +A new `release/x.y.z` branch must be created for **every release**. + +1. **Create a `release/` branch from `master`:** + + ```bash + git checkout master + git checkout -b release/1.2.0 + ``` + +2. **Merge in `develop` or selected branches if `develop` is not ready:** + + ```bash + git merge develop + # or + git merge feature/finished-feature + git merge feature/another-complete-feature + ``` + +3. **Polish, test, and fix issues as needed.** + +4. **Merge back into `develop`:** + + ```bash + git checkout develop + git merge release/1.2.0 + git push origin develop + ``` + +5. **Finalize the release:** + + ```bash + git checkout master + git merge release/1.2.0 + git tag v1.2.0 + git push origin master --tags + ``` + +6. **Delete the release branch:** + + ```bash + git branch -d release/1.2.0 + git push origin --delete release/1.2.0 + ``` + From 4c01456565c5b7370ee03206f95dd0c0ad910208 Mon Sep 17 00:00:00 2001 From: PhilReact Date: Mon, 21 Apr 2025 14:56:59 +0300 Subject: [PATCH 2/3] moved readme --- README.md | 84 -------------------------------------------- docs/contribution.md | 84 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 84 insertions(+), 84 deletions(-) create mode 100644 docs/contribution.md diff --git a/README.md b/README.md index 001c6e9..5ffbaf6 100644 --- a/README.md +++ b/README.md @@ -18,87 +18,3 @@ Leveraging a redundant set of publicly accessible nodes provided by crowetic, Qo Many additional details and a fully featured wiki will be created over time. Reach out on the chat on https://qortal.dev or in any of the community locations for Qortal, if you have any issues. Thank you! - -# 🤝 Contributing Guide - -Thank you for your interest in contributing! We follow a structured Git workflow to keep the project clean, stable, and production-ready at all times. - ---- - -## 📦 Branch Overview - -| Branch | Purpose | -|------------------|----------------------------------------------------------| -| `master` | Stable, production-ready code. All releases are tagged here. | -| `develop` | Active development branch. All new features go here first. | -| `release/x.y.z` | Pre-release branch for staging, QA, and final polish. | - ---- - -## 🌿 Creating a Feature or Fix - -1. **Start from `develop`:** - - ```bash - git checkout develop - git checkout -b feature/your-feature-name - ``` - -2. **Make your changes and commit them.** - -3. **Push your branch:** - - ```bash - git push origin feature/your-feature-name - ``` - -4. **Open a Pull Request into `develop`.** - ---- - -## 🚀 Releasing Code (Maintainers Only) - -A new `release/x.y.z` branch must be created for **every release**. - -1. **Create a `release/` branch from `master`:** - - ```bash - git checkout master - git checkout -b release/1.2.0 - ``` - -2. **Merge in `develop` or selected branches if `develop` is not ready:** - - ```bash - git merge develop - # or - git merge feature/finished-feature - git merge feature/another-complete-feature - ``` - -3. **Polish, test, and fix issues as needed.** - -4. **Merge back into `develop`:** - - ```bash - git checkout develop - git merge release/1.2.0 - git push origin develop - ``` - -5. **Finalize the release:** - - ```bash - git checkout master - git merge release/1.2.0 - git tag v1.2.0 - git push origin master --tags - ``` - -6. **Delete the release branch:** - - ```bash - git branch -d release/1.2.0 - git push origin --delete release/1.2.0 - ``` - diff --git a/docs/contribution.md b/docs/contribution.md new file mode 100644 index 0000000..b86ad3b --- /dev/null +++ b/docs/contribution.md @@ -0,0 +1,84 @@ + +# 🤝 Contributing Guide + +Thank you for your interest in contributing! We follow a structured Git workflow to keep the project clean, stable, and production-ready at all times. + +--- + +## 📦 Branch Overview + +| Branch | Purpose | +|------------------|----------------------------------------------------------| +| `master` | Stable, production-ready code. All releases are tagged here. | +| `develop` | Active development branch. All new features go here first. | +| `release/x.y.z` | Pre-release branch for staging, QA, and final polish. | + +--- + +## 🌿 Creating a Feature or Fix + +1. **Start from `develop`:** + + ```bash + git checkout develop + git checkout -b feature/your-feature-name + ``` + +2. **Make your changes and commit them.** + +3. **Push your branch:** + + ```bash + git push origin feature/your-feature-name + ``` + +4. **Open a Pull Request into `develop`.** + +--- + +## 🚀 Releasing Code (Maintainers Only) + +A new `release/x.y.z` branch must be created for **every release**. + +1. **Create a `release/` branch from `master`:** + + ```bash + git checkout master + git checkout -b release/1.2.0 + ``` + +2. **Merge in `develop` or selected branches if `develop` is not ready:** + + ```bash + git merge develop + # or + git merge feature/finished-feature + git merge feature/another-complete-feature + ``` + +3. **Polish, test, and fix issues as needed.** + +4. **Merge back into `develop`:** + + ```bash + git checkout develop + git merge release/1.2.0 + git push origin develop + ``` + +5. **Finalize the release:** + + ```bash + git checkout master + git merge release/1.2.0 + git tag v1.2.0 + git push origin master --tags + ``` + +6. **Delete the release branch:** + + ```bash + git branch -d release/1.2.0 + git push origin --delete release/1.2.0 + ``` + From 8140eb7058081ee173ec2ebdcbc1aa9faddd966e Mon Sep 17 00:00:00 2001 From: Phillip <48392931+Philreact@users.noreply.github.com> Date: Mon, 21 Apr 2025 14:59:06 +0300 Subject: [PATCH 3/3] Update docs/contribution.md Co-authored-by: nico.benaz <52411515+nbenaglia@users.noreply.github.com> --- docs/contribution.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contribution.md b/docs/contribution.md index b86ad3b..07d06fe 100644 --- a/docs/contribution.md +++ b/docs/contribution.md @@ -9,7 +9,7 @@ Thank you for your interest in contributing! We follow a structured Git workflow | Branch | Purpose | |------------------|----------------------------------------------------------| -| `master` | Stable, production-ready code. All releases are tagged here. | +| `master` | Stable, production-ready code. All releases are tagged from here. | | `develop` | Active development branch. All new features go here first. | | `release/x.y.z` | Pre-release branch for staging, QA, and final polish. |