docs: correct active development workflow
Co-authored-by: arena-agent <297053741+arena-agent@users.noreply.github.com>
This commit is contained in:
co-authored by
arena-agent
parent
a77bfc5070
commit
c447674ef9
+22
-17
@@ -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.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user