From e6245652e20ed88a70e92fd79a2cb440b1f42af9 Mon Sep 17 00:00:00 2001
From: Gabriel Le Breton <lebreton.gabriel@gmail.com>
Date: Thu, 21 Nov 2024 21:10:53 -0500
Subject: [PATCH 1/2] Update contribution guidelines and add development
 section

---
 README.md | 28 +++++++++++++++++++++++++++-
 1 file changed, 27 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 04113a4..ad42314 100644
--- a/README.md
+++ b/README.md
@@ -14,7 +14,7 @@ Easily build and test your Unity project.
 
 ### How to Contribute
 
-We welcome [issues](https://github.com/game-ci/unity-orb/issues) to and [pull requests](https://github.com/game-ci/unity-orb/pulls) against this repository!
+We welcome [issues](https://github.com/game-ci/unity-orb/issues) and [pull requests](https://github.com/game-ci/unity-orb/pulls) against this repository! For detailed guidelines, see [CONTRIBUTING.md](./CONTRIBUTING.md).
 
 ### How to Publish An Update
 
@@ -44,3 +44,29 @@ circleci orb pack src > unity-orb.yml
 circleci orb publish unity-orb.yml <my-namespace>/<my-orb-name>@dev:first
 circleci orb publish promote <my-namespace>/<my-orb-name>@dev:first patch
 ```
+
+## Development
+
+If you'd like to contribute to this orb and test your changes:
+
+1. **Fork this repository.**
+2. **Make your changes** in a new branch.
+3. **Pack and publish your fork** to a personal namespace:
+
+   ```bash
+   circleci orb pack src > unity-orb.yml
+   circleci orb publish unity-orb.yml <your-namespace>/<your-orb-name>@dev:first
+   ```
+
+4. **Use your fork in your CircleCI workflow.**
+
+   Update your `.circleci/config.yml` to reference your development version:
+
+   ```yaml
+   orbs:
+     unity: <your-namespace>/<your-orb-name>@dev:first
+   ```
+
+## License
+
+[MIT](LICENSE)

From 161895683c4fb670339ae2565632293616e3631a Mon Sep 17 00:00:00 2001
From: Gabriel Le Breton <lebreton.gabriel@gmail.com>
Date: Thu, 21 Nov 2024 21:21:14 -0500
Subject: [PATCH 2/2] Update instructions for development and deployment of
 private orbs

---
 README.md | 38 ++++++++++++++++++++------------------
 1 file changed, 20 insertions(+), 18 deletions(-)

diff --git a/README.md b/README.md
index ad42314..8a78cea 100644
--- a/README.md
+++ b/README.md
@@ -32,41 +32,43 @@ We welcome [issues](https://github.com/game-ci/unity-orb/issues) and [pull reque
 6. Click _"Publish Release"_.
     - This will push a new tag and trigger your publishing pipeline on CircleCI.
 
-### Manual Deploy
+## Development and Manual Deploy
 
-If you want a private orb for your build env. The following steps allow you to do so. These are adapted from the CircleCI
-[Manual Orb Authoring Process](https://circleci.com/docs/orb-author-validate-publish/#publish-your-orb)
+> **Note:** Development and private orbs should only be used for testing purposes. Always review and validate changes thoroughly before using in production.
 
-```bash
-circleci namespace create <name> --org-id <your-organization-id>
-circleci orb create <my-namespace>/<my-orb-name> --private
-circleci orb pack src > unity-orb.yml
-circleci orb publish unity-orb.yml <my-namespace>/<my-orb-name>@dev:first
-circleci orb publish promote <my-namespace>/<my-orb-name>@dev:first patch
-```
+If you want to contribute to this orb or deploy a private version for testing, follow these steps:
 
-## Development
+1. **Fork this repository (optional for private orbs).**
+2. **Set your namespace and orb name** to make the steps easier:
 
-If you'd like to contribute to this orb and test your changes:
+   ```bash
+   export NAMESPACE="<your-namespace>"
+   export ORB_NAME="<your-orb-name>"
+   export VERSION="dev:first"
+   ```
 
-1. **Fork this repository.**
-2. **Make your changes** in a new branch.
-3. **Pack and publish your fork** to a personal namespace:
+3. **Pack and publish your orb:**
 
    ```bash
    circleci orb pack src > unity-orb.yml
-   circleci orb publish unity-orb.yml <your-namespace>/<your-orb-name>@dev:first
+   circleci orb publish unity-orb.yml "$NAMESPACE/$ORB_NAME@$VERSION"
    ```
 
-4. **Use your fork in your CircleCI workflow.**
+4. **Use your orb in your CircleCI workflow:**
 
-   Update your `.circleci/config.yml` to reference your development version:
+   Update your `.circleci/config.yml` to reference your custom version:
 
    ```yaml
    orbs:
      unity: <your-namespace>/<your-orb-name>@dev:first
    ```
 
+5. **Promote the version** to a higher semantic version if needed (optional):
+
+   ```bash
+   circleci orb publish promote "$NAMESPACE/$ORB_NAME@$VERSION" patch
+   ```
+
 ## License
 
 [MIT](LICENSE)