Skip to content
This repository was archived by the owner on Apr 3, 2025. It is now read-only.

Commit 9ef6481

Browse files
committed
docs: clarify command line in README
1 parent db72800 commit 9ef6481

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

README.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,21 @@ Folgende Präfixe stehen durch die Konfiguration [`.releaserc.json`](.releaserc.
3030

3131
Beispiele
3232

33-
- Einführung von neuen Tests: `test: add new unit tests`, erhöht die Version von z.B. `1.0.0` auf `1.0.1`
34-
- Einführung von neuen Features: `feat: add new features`, erhöht die Version von z.B. `1.0.0` auf `1.1.0`
35-
- Einführung von neuen Features, die nicht abwärtskompatibel sind: `feat!: add new features`, erhöht die Version von z.B. `1.0.0` auf `2.0.0`
33+
- Einführung von neuen Tests, erhöht die Version von z.B. `1.0.0` auf `1.0.1`:
3634

37-
> **Hinweis**:
38-
Der `develop` Branch ist als Prerelease konfiguriert, d.h. die Versionierung weicht von der üblichen semantischen Versionierung ab. Das ist nötig, um unterscheiden zu können, ob das Release vom `develop` oder vom `master` genutzt wird. Auf dem `develop` Branch beinhaltet die Version daher zusätzlich `develop` und eine Buildnummer, z.B. `1.1.0-develop.1`
35+
`$ git commit -m "test: add new unit tests"`
36+
37+
- Einführung von neuen Features, erhöht die Version von z.B. `1.0.0` auf `1.1.0`:
38+
39+
`$ git commit -m "feat: add new features"`
40+
41+
- Einführung von neuen Features, die nicht abwärtskompatibel sind, erhöht die Version von z.B. `1.0.0` auf `2.0.0`:
42+
43+
`$ git commit -m "feat!: add new features"`
44+
45+
### `develop` Branch
46+
47+
Der `develop` Branch ist als Pre-Release konfiguriert. Das ist nötig, um unterscheiden zu können, ob das Release vom `develop` oder vom `master` genutzt wird. Auf dem `develop` Branch beinhaltet die Version daher zusätzlich `develop` und eine Buildnummer, z.B. `1.1.0-develop.1`
3948

4049
```
4150
name: Release Pipeline

0 commit comments

Comments
 (0)