Sovran_Systems/Sovran_SystemsOS
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

Merge pull request #380 from naturallaw777/arena/019fcdbe-sovran-systemsos

Browse Source 
docs: correct active development workflow
This commit is contained in:
Sovran Systems
2026-08-04 12:17:34 -05:00
committed by GitHub
parent a77bfc5070 c447674ef9
commit 4b9800aef3
2 changed files with 64 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+22 -17
View File
@@ -2,28 +2,33 @@
First off, thank you for considering contributing to Sovran_SystemsOS! 🎉 First off, thank you for considering contributing to Sovran_SystemsOS! 🎉
## This GitHub Repo ## Development and Release Repositories
The GitHub repository is the **development mirror** of Sovran_SystemsOS and serves as The GitHub repository is the primary location for Sovran_SystemsOS development
its connection to the GitHub ecosystem. The **main, stable repository** is and collaboration and serves as the project's connection to the GitHub
self-hosted on the project's Gitea instance at ecosystem. Most work is contributed through feature branches and pull requests
https://git.sovransystems.com/Sovran_Systems/Sovran_SystemsOS that target GitHub `main`. Development may also begin in a local branch or on
([`stable` branch](https://git.sovransystems.com/Sovran_Systems/Sovran_SystemsOS/src/branch/stable)), `staging-dev` at the project's self-hosted Gitea instance:
as the ethos of Sovran_SystemsOS is self-sovereignty. https://git.sovransystems.com/Sovran_Systems/Sovran_SystemsOS.
GitHub `main` and Gitea `staging-dev` are kept synchronized as the active
development line, although one may briefly lead the other while changes are
being integrated. The canonical, release-ready code is maintained on Gitea's
[`stable` branch](https://git.sovransystems.com/Sovran_Systems/Sovran_SystemsOS/src/branch/stable),
in keeping with the self-sovereignty ethos of Sovran_SystemsOS.
The workflow is: The workflow is:
1. Development happens on the `staging-dev` branch on Gitea, which the GitHub 1. Most development and project collaboration — including issues, pull
repository mirrors. requests, and reviews — happens through GitHub, with completed work
2. All activity in the GitHub repo — issues, pull requests, reviews, and integrated into `main`.
testing — is done against the mirrored `staging-dev` code. 2. Work may also originate locally or on Gitea `staging-dev`. Accepted changes
3. When changes are complete and tested, they are moved to the `stable` branch are synchronized between GitHub `main` and Gitea `staging-dev`.
on the Gitea instance, which is the code used by released Sovran_SystemsOS 3. When changes are complete and tested, they are promoted to Gitea `stable`,
builds. which is the code used by released Sovran_SystemsOS builds.
Please note: the GitHub repo mirrors `staging-dev`, so it may contain new features Please note: GitHub `main` and Gitea `staging-dev` may contain new features and
and code not yet in the `stable` branch on Gitea, and this code is not fully code not yet in `stable`, and that code may not be fully tested.
tested.
Moreover, Sovran_SystemsOS has been improved with the help of AI. We have used Copilot and Arean.Ai to work through significant coding challenges and troubleshooting hurdles. We will continue to use AI to help keep Sovran_SystemsOS stable and maintained. Moreover, Sovran_SystemsOS has been improved with the help of AI. We have used Copilot and Arean.Ai to work through significant coding challenges and troubleshooting hurdles. We will continue to use AI to help keep Sovran_SystemsOS stable and maintained.
README.md
+42 -33
View File
@@ -31,16 +31,19 @@ are ready.
</div> </div>
> **📌 Development mirror — stable releases live on Gitea** > **📌 Active development — stable releases live on Gitea**
> >
> The [GitHub repository](https://github.com/naturallaw777/Sovran_SystemsOS) is > Most development and collaboration happens through the
> the **development mirror** of this project. It mirrors the `staging-dev` > [GitHub repository](https://github.com/naturallaw777/Sovran_SystemsOS), with
> branch from the project's self-hosted Gitea instance. Changes are tested > changes integrated into its `main` branch. Work may also begin locally or on
> there, and once complete they are moved to the `stable` branch on > the `staging-dev` branch of the project's self-hosted Gitea instance. GitHub
> `main` and Gitea `staging-dev` are kept synchronized as the active development
> line. Once changes are complete and tested, they are promoted to the `stable`
> branch on
> [git.sovransystems.com](https://git.sovransystems.com/Sovran_Systems/Sovran_SystemsOS/src/branch/stable) > [git.sovransystems.com](https://git.sovransystems.com/Sovran_Systems/Sovran_SystemsOS/src/branch/stable)
> — the canonical, release-ready home of Sovran_SystemsOS. Code in the GitHub > — the canonical, release-ready home of Sovran_SystemsOS. Development code may
> repository may be newer and less tested than the Gitea `stable` branch. > be newer and less tested than Gitea `stable`. See
> See [Development workflow](#development-workflow) for details. > [Development workflow](#development-workflow) for details.
--- ---
@@ -468,30 +471,35 @@ optional self-hosting services are all maintained in this repository.
### Development workflow ### Development workflow
Sovran_SystemsOS development is split across two repositories: Sovran_SystemsOS uses two hosted repositories, as well as local development
branches:
- **[GitHub](https://github.com/naturallaw777/Sovran_SystemsOS)** — the primary
location for development and collaboration and the project's connection to
the GitHub ecosystem. Most feature branches and pull requests target its
`main` branch.
- **[git.sovransystems.com (self-hosted Gitea)](https://git.sovransystems.com/Sovran_Systems/Sovran_SystemsOS)** — the - **[git.sovransystems.com (self-hosted Gitea)](https://git.sovransystems.com/Sovran_Systems/Sovran_SystemsOS)** — the
canonical home of the project, in keeping with the ethos of self-sovereignty. canonical home of the project, in keeping with the ethos of self-sovereignty.
Its [`stable` branch](https://git.sovransystems.com/Sovran_Systems/Sovran_SystemsOS/src/branch/stable) Its `staging-dev` branch is part of the active development line and can also
holds the tested, release-ready code, and its `staging-dev` branch holds receive development work. Its
work in progress. [`stable` branch](https://git.sovransystems.com/Sovran_Systems/Sovran_SystemsOS/src/branch/stable)
- **[GitHub](https://github.com/naturallaw777/Sovran_SystemsOS)** — the holds the tested, release-ready code.
development mirror and the project's connection to the GitHub ecosystem. It
mirrors the `staging-dev` branch from Gitea.
The workflow is: Development can begin on GitHub, on Gitea `staging-dev`, or in a local branch.
In practice:
1. Development happens on the `staging-dev` branch on Gitea, which the GitHub 1. Most development and project collaboration — including issues, pull
repository mirrors. requests, and reviews — happens through GitHub, with completed work
2. All activity in the GitHub repository — issues, pull requests, reviews, integrated into `main`.
and testing — is done against the mirrored `staging-dev` code. 2. Accepted changes are synchronized between GitHub `main` and Gitea
3. When changes are complete and tested, they are moved to the `stable` branch `staging-dev`, so together they represent the active development line. One
on the Gitea instance, which is the code used by released may briefly lead the other while changes are being integrated.
Sovran_SystemsOS builds. 3. When changes are complete and tested, they are promoted to the `stable`
branch on Gitea, which is the code used by released Sovran_SystemsOS builds.
> ⚠️ Because the GitHub repository tracks `staging-dev`, it may contain new > ⚠️ GitHub `main` and Gitea `staging-dev` may contain new features and code
> features and code that are not yet fully tested or released. For the current > that are not yet fully tested or released. For the current stable, audited
> stable, audited code, use the `stable` branch on > code, use the `stable` branch on
> [git.sovransystems.com](https://git.sovransystems.com/Sovran_Systems/Sovran_SystemsOS/src/branch/stable). > [git.sovransystems.com](https://git.sovransystems.com/Sovran_Systems/Sovran_SystemsOS/src/branch/stable).
### Technology ### Technology
@@ -521,8 +529,9 @@ git clone -b stable https://git.sovransystems.com/Sovran_Systems/Sovran_SystemsO
cd Sovran_SystemsOS cd Sovran_SystemsOS
``` ```
or clone the **development mirror** from GitHub, which tracks Gitea's or clone the **active development code** from GitHub. GitHub `main` and Gitea
`staging-dev` branch and may contain untested changes: `staging-dev` are kept synchronized and may contain changes that are not yet
fully tested or released:
```bash ```bash
git clone https://github.com/naturallaw777/Sovran_SystemsOS.git git clone https://github.com/naturallaw777/Sovran_SystemsOS.git
@@ -816,11 +825,11 @@ Read the complete license terms in [`LICENSE`](LICENSE).
We welcome contributions! The We welcome contributions! The
[GitHub repository](https://github.com/naturallaw777/Sovran_SystemsOS) is the [GitHub repository](https://github.com/naturallaw777/Sovran_SystemsOS) is the
**development mirror** — the stable, tested releases are maintained on the primary location for development and collaboration. Its `main` branch is kept
`stable` branch of the self-hosted synchronized with `staging-dev` on the self-hosted
[Gitea instance](https://git.sovransystems.com/Sovran_Systems/Sovran_SystemsOS). [Gitea instance](https://git.sovransystems.com/Sovran_Systems/Sovran_SystemsOS),
Please read our [Contributing Guidelines](CONTRIBUTING.md) before submitting a where the `stable` branch holds tested, release-ready code. Please read our
pull request. [Contributing Guidelines](CONTRIBUTING.md) before submitting a pull request.
<div align="center"> <div align="center">