Skip to content

Commit f80efbe

Browse files
committed
@README.md#beta-tests--preview-builds: improve
This section now documents which `git branch` has which uses. Is followup to: HEAD~1 (@`README.md`: `s|experimental|preview|`).
1 parent eb955cd commit f80efbe

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -214,10 +214,16 @@ Usage: [`./build.sh [OPTIONS]`](./build.sh) produces objects (`./obj/*.o`, for d
214214
# How to contribute
215215
View [documented issues](https://github.com/SwuduSusuwu/SusuLib/issues/) (for ideas on code to contribute, plus so you do not report documented issues.)
216216
## Beta tests / `preview` builds
217+
`git branch`s:
218+
- [`trunk`](https://github.com/SwuduSusuwu/SusuLib/tree/trunk) publishes what most projects call "releases", with changes limited to what [*SemVer* calls "Patch" revisions](https://semver.org/spec/v2.0.0.html#spec-item-6)
219+
- [`new`](https://github.com/SwuduSusuwu/SusuLib/tree/new) publishes what most projects call "release candidates", with changes limited to what [*SemVer* calls "Minor" revisions](https://semver.org/spec/v2.0.0.html#spec-item-7)
220+
- [`preview`](https://github.com/SwuduSusuwu/SusuLib/tree/preview) publishes what most projects call "beta tests", with changes up to what [*SemVer* calls "Major" revisions](https://semver.org/spec/v2.0.0.html#spec-item-8)
221+
222+
How to use the most new sources:
217223
- `git switch preview && ./build.sh`
218224
- View results for symptoms of new issues (hint: look for "Warning:"s or "Error:"s).
219225
- If you found new issue(s) (which aren't due to misconfigurations in your system), [post new issue(s)](https://github.com/SwuduSusuwu/SusuLib/issues/new).
220-
- Notice: [sensitive issue(s)](./SECURITY.md#sensitive-issues) have a separate protocol.
226+
- Notice: [sensitive issue(s) have this separate mechanism to use](./SECURITY.md#sensitive-issues).
221227

222228
# Contributor conventions / rules
223229
General comment/message syntax rules:

0 commit comments

Comments
 (0)