Skip to content

Commit 8542317

Browse files
committed
📚 docs: added release.md #14
1 parent 3cbfab3 commit 8542317

File tree

1 file changed

+53
-0
lines changed

1 file changed

+53
-0
lines changed

RELEASE.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Version Releases
2+
3+
## Semantic Versioning (SemVer): `vMAJOR.MINOR.PATCH`
4+
5+
Example:
6+
7+
- v1.0.0
8+
- v1.0.1
9+
- v1.1.1
10+
11+
## Pre-release versions: `vMAJOR.MINOR.PATCH-<BETA/RC/SNAPSHOT>.<number>`
12+
13+
Example:
14+
15+
- v1.0.0-beta.1
16+
- v1.0.0-beta.2
17+
- v1.2.3-rc1
18+
- v1.2.3-SNAPSHOT
19+
20+
## Post-release versions: `vMAJOR.MINOR.PATCH-POST.<number>`
21+
22+
Example:
23+
24+
- v1.2.3-post.1
25+
- v1.2.3-post.2
26+
27+
## Local versions: `vMAJOR.MINOR.PATCH+LOCAL`
28+
29+
Example:
30+
31+
- v1.0.0+local
32+
- v1.1.0+local
33+
34+
## Caret range versions: `^MAJOR.MINOR.PATCH`
35+
36+
Example:
37+
38+
- ^1.2.3 (similar `>=1.2.3 < 2.0.0`)
39+
40+
## Tilde range versions: `~MAJOR.MINOR.PATCH`
41+
42+
Example:
43+
44+
- ~1.2.3 (similar `>=1.2.3 <1.3.0`)
45+
46+
---
47+
48+
Notes:
49+
50+
- `MAJOR`: major version.
51+
- `MINOR`: Minor version, often adding new features.
52+
- `PATCH`: Patch version, typically fixing bugs.
53+
- `SNAPSHOT`: Indicates a version under development or in progress. It is often used to represent the latest state of the codebase and may include ongoing changes and features that are not yet finalized. This allows developers to work with the most recent developments in a project.

0 commit comments

Comments
 (0)