Compare commits

...
4 Commits
Author SHA1 Message Date
Sovran Systems f39f59fb81 Merge pull request #381 from naturallaw777/arena/019fcde4-sovran-systemsos
Trim redundant dev-vs-stable Gitea explanations in README
2026-08-04 13:24:52 -05:00
naturallaw777andarena-agent 61fc61cceb Trim redundant dev-vs-stable Gitea explanations in README
Replace repeated prose across 4 sections with a compact table + flow arrow:
- Top callout: 7-line paragraph → 2-line summary + link
- Development workflow: 2 bullets + 3-step list + warning → 3-row table + flow arrow
- Build from source: re-explained sync relationship → single labels on clone commands
- Contributing footer: repeated branch/host info → one sentence

No information lost; ~270 words removed.

Co-authored-by: arena-agent <297053741+arena-agent@users.noreply.github.com>
2026-08-04 18:23:54 +00:00
Sovran Systems 4b9800aef3 Merge pull request #380 from naturallaw777/arena/019fcdbe-sovran-systemsos
docs: correct active development workflow
2026-08-04 12:17:34 -05:00
naturallaw777andarena-agent c447674ef9 docs: correct active development workflow
Co-authored-by: arena-agent <297053741+arena-agent@users.noreply.github.com>
2026-08-04 17:16:46 +00:00
2 changed files with 37 additions and 57 deletions

No files matched your search

+22 -17
View File
@@ -2,28 +2,33 @@
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
its connection to the GitHub ecosystem. The **main, stable repository** is
self-hosted on the project's Gitea instance at
https://git.sovransystems.com/Sovran_Systems/Sovran_SystemsOS
([`stable` branch](https://git.sovransystems.com/Sovran_Systems/Sovran_SystemsOS/src/branch/stable)),
as the ethos of Sovran_SystemsOS is self-sovereignty.
The GitHub repository is the primary location for Sovran_SystemsOS development
and collaboration and serves as the project's connection to the GitHub
ecosystem. Most work is contributed through feature branches and pull requests
that target GitHub `main`. Development may also begin in a local branch or on
`staging-dev` at the project's self-hosted Gitea instance:
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:
1. Development happens on the `staging-dev` branch on Gitea, which the GitHub
repository mirrors.
2. All activity in the GitHub repo — issues, pull requests, reviews, and
testing — is done against the mirrored `staging-dev` code.
3. When changes are complete and tested, they are moved to the `stable` branch
on the Gitea instance, which is the code used by released Sovran_SystemsOS
builds.
1. Most development and project collaboration — including issues, pull
requests, and reviews — happens through GitHub, with completed work
integrated into `main`.
2. Work may also originate locally or on Gitea `staging-dev`. Accepted changes
are synchronized between GitHub `main` and Gitea `staging-dev`.
3. When changes are complete and tested, they are promoted to Gitea `stable`,
which is the code used by released Sovran_SystemsOS builds.
Please note: the GitHub repo mirrors `staging-dev`, so it may contain new features
and code not yet in the `stable` branch on Gitea, and this code is not fully
tested.
Please note: GitHub `main` and Gitea `staging-dev` may contain new features and
code not yet in `stable`, and that code may not be fully 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.
+15 -40
View File
@@ -31,15 +31,8 @@ are ready.
</div>
> **📌 Development mirror — stable releases live on Gitea**
>
> The [GitHub repository](https://github.com/naturallaw777/Sovran_SystemsOS) is
> the **development mirror** of this project. It mirrors the `staging-dev`
> branch from the project's self-hosted Gitea instance. Changes are tested
> there, and once complete they are moved to the `stable` branch on
> [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
> repository may be newer and less tested than the Gitea `stable` branch.
> **📌 Active development on GitHub `main` / Gitea `staging-dev` — releases on
> [Gitea `stable`](https://git.sovransystems.com/Sovran_Systems/Sovran_SystemsOS/src/branch/stable).**
> See [Development workflow](#development-workflow) for details.
---
@@ -468,31 +461,17 @@ optional self-hosting services are all maintained in this repository.
### Development workflow
Sovran_SystemsOS development is split across two repositories:
| Branch | Host | Purpose |
|---------------|---------------------------------------------------|-----------------------------|
| `main` | [GitHub](https://github.com/naturallaw777/Sovran_SystemsOS) | Active development & PRs |
| `staging-dev` | [Gitea](https://git.sovransystems.com/Sovran_Systems/Sovran_SystemsOS) | Synced with `main` |
| `stable` | [Gitea](https://git.sovransystems.com/Sovran_Systems/Sovran_SystemsOS/src/branch/stable) | Tested, release-ready builds |
- **[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.
Its [`stable` branch](https://git.sovransystems.com/Sovran_Systems/Sovran_SystemsOS/src/branch/stable)
holds the tested, release-ready code, and its `staging-dev` branch holds
work in progress.
- **[GitHub](https://github.com/naturallaw777/Sovran_SystemsOS)** — the
development mirror and the project's connection to the GitHub ecosystem. It
mirrors the `staging-dev` branch from Gitea.
**Flow:** develop → sync `main` ↔ `staging-dev` → promote to `stable`
The workflow is:
1. Development happens on the `staging-dev` branch on Gitea, which the GitHub
repository mirrors.
2. All activity in the GitHub repository — issues, pull requests, reviews,
and testing — is done against the mirrored `staging-dev` code.
3. When changes are complete and tested, they are moved to the `stable` branch
on the Gitea instance, which is the code used by released
Sovran_SystemsOS builds.
> ⚠️ Because the GitHub repository tracks `staging-dev`, it may contain new
> features and code that are not yet fully tested or released. For the current
> stable, audited code, use the `stable` branch on
> [git.sovransystems.com](https://git.sovransystems.com/Sovran_Systems/Sovran_SystemsOS/src/branch/stable).
> ⚠️ `main` and `staging-dev` may contain unreleased or less-tested code. For
> stable, audited code, use Gitea
> [`stable`](https://git.sovransystems.com/Sovran_Systems/Sovran_SystemsOS/src/branch/stable).
### Technology
@@ -514,15 +493,14 @@ The workflow is:
You need a system with Nix installed and flakes enabled.
Clone the **stable** code from the self-hosted Gitea instance (recommended):
Clone the **stable** branch from Gitea (recommended for builds):
```bash
git clone -b stable https://git.sovransystems.com/Sovran_Systems/Sovran_SystemsOS.git
cd Sovran_SystemsOS
```
or clone the **development mirror** from GitHub, which tracks Gitea's
`staging-dev` branch and may contain untested changes:
Or clone the **active development** line from GitHub:
```bash
git clone https://github.com/naturallaw777/Sovran_SystemsOS.git
@@ -816,11 +794,8 @@ Read the complete license terms in [`LICENSE`](LICENSE).
We welcome contributions! The
[GitHub repository](https://github.com/naturallaw777/Sovran_SystemsOS) is the
**development mirror** — the stable, tested releases are maintained on the
`stable` branch of the self-hosted
[Gitea instance](https://git.sovransystems.com/Sovran_Systems/Sovran_SystemsOS).
Please read our [Contributing Guidelines](CONTRIBUTING.md) before submitting a
pull request.
primary location for collaboration. Please read our
[Contributing Guidelines](CONTRIBUTING.md) before submitting a pull request.
<div align="center">