From 8e2e8aa05e240373d6dc5a0a1c134794aa84d211 Mon Sep 17 00:00:00 2001 From: Cole Medin Date: Sat, 13 Sep 2025 11:03:03 -0500 Subject: [PATCH] Adding instructions for stable branch. --- CONTRIBUTING.md | 6 ++++-- README.md | 4 +++- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 47be2e3..9c2f0c6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -149,7 +149,7 @@ Test these things using both the UI and the MCP server. This process will be sim - This creates your own copy of the repository ```bash - # Clone your fork (replace 'your-username' with your GitHub username) + # Clone your fork from main branch for contributing (replace 'your-username' with your GitHub username) git clone https://github.com/your-username/archon.git cd archon @@ -157,6 +157,8 @@ Test these things using both the UI and the MCP server. This process will be sim git remote add upstream https://github.com/coleam00/archon.git ``` + **Note:** The `main` branch is used for contributions and contains the latest development work. The `stable` branch is for users who want a more tested, stable version of Archon. + 2. **🤖 AI Coding Assistant Setup** **IMPORTANT**: If you're using AI coding assistants to help contribute to Archon, set up our global rules for optimal results. @@ -169,7 +171,7 @@ Test these things using both the UI and the MCP server. This process will be sim 3. **Create Feature Branch** - **Best Practice**: Always create a feature branch rather than working directly on main. This keeps your main branch clean and makes it easier to sync with the upstream repository. + **Best Practice**: Always create a feature branch from main rather than working directly on it. This keeps your main branch clean and makes it easier to sync with the upstream repository. ```bash git checkout -b feature/your-feature-name diff --git a/README.md b/README.md index de2a9ed..d0440f1 100644 --- a/README.md +++ b/README.md @@ -54,11 +54,13 @@ This new vision for Archon replaces the old one (the agenteer). Archon used to b 1. **Clone Repository**: ```bash - git clone https://github.com/coleam00/archon.git + git clone -b stable https://github.com/coleam00/archon.git ``` ```bash cd archon ``` + + **Note:** The `stable` branch is recommended for using Archon. If you want to contribute or try the latest features, use the `main` branch with `git clone https://github.com/coleam00/archon.git` 2. **Environment Configuration**: ```bash