mawei/sunnypilot
1
0
Fork 0
mirror of https://github.com/sunnypilot/sunnypilot.git synced 2026-07-15 15:22:08 +08:00
Code Issues Packages Projects Releases Wiki Activity

definitions

Browse Source
This commit is contained in:
Jason Wen
2024-08-04 23:37:24 -04:00
parent 188aa8374a
commit 36f1bf0adb
2 changed files with 13 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs_sp/branches/definitions.md
+11
View File
@@ -0,0 +1,11 @@
# **Definitions**
| Branch | Definition | Description | Stability/Readiness |
|:------------:|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| `release-c3` | Release branch | Stable release branches. After testing on `staging-c3`, updates are pushed here and published publicly. | **Ready to Use:** Highly stable, recommended for most users. |
| `staging-c3` | Staging branch | Pre-release testing branches. Community feedback is essential to identify issues before public release. | **Varied Stability:** Generally stable, but intended for testing before public release. |
| `dev-c3` | Development branches | Experimental branches with the latest features and bug fixes brought in manually. Expect bugs and braking changes. | **Experimental:** Least stable, suitable for testers and developers. |
| `master` | Primary development branch | All Pull Requests are merged here for future releases. CI automatically strips, minifies, and pushes changes to `staging-c3`. Running the `master` branch is suitable for development purposes but not recommended for non-development use. | **For Development Use:** Suitable for developers, may be unstable for general use. |
!!! note
Your feedback is invaluable. Testers, even without software development experience, are encourage to run `dev-c3` and report issues.
mkdocs-sp.yml
+2
View File
@@ -80,6 +80,8 @@ nav:
- installation/index.md
- URL Method: installation/url-method.md
- SSH Method: installation/ssh-method.md
- Branches:
- Definitions: branches/definitions.md
- Features:
- Modified Assistive Driving Safety (MADS): features/modified-assistive-driving-safety.md
- Dynamic Lane Profile (DLP): features/dynamic-lane-profile.md