You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
chore: add bump-patch-version command and update documentation
- Add bump-patch-version justfile command for both Windows and Unix
- Update RELEASE_PROCESS.md to document all three version bump types
- Change "we" to "I" in CONTRIBUTING.md for consistency
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ Nightshade is currently in its early stages of development. The project is not a
8
8
9
9
## Future Contributions
10
10
11
-
Once the engine reaches a more mature and stable state, we will open up contributions and provide detailed contributor guidelines. At that time, this document will be updated with:
11
+
Once the engine reaches a more mature and stable state, I will open up contributions and provide detailed contributor guidelines. At that time, this document will be updated with:
Copy file name to clipboardExpand all lines: RELEASE_PROCESS.md
+21-2Lines changed: 21 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,14 +4,23 @@ This project uses [git-cliff](https://git-cliff.org/) for automated changelog ge
4
4
5
5
## Creating a New Release
6
6
7
-
1. Bump the version (patch version):
7
+
1. Bump the version:
8
+
9
+
For a patch version bump (bug fixes, minor changes):
10
+
```bash
11
+
just bump-patch-version
12
+
```
13
+
14
+
For a minor version bump (new features, backwards compatible):
8
15
```bash
9
16
just bump-minor-version
10
17
```
11
-
Or for a major version bump:
18
+
19
+
For a major version bump (breaking changes):
12
20
```bash
13
21
just bump-major-version
14
22
```
23
+
15
24
This will:
16
25
- Update version in `Cargo.toml` and `crates/nightshade/README.md`
17
26
- Create a commit with the version bump
@@ -30,6 +39,16 @@ This project uses [git-cliff](https://git-cliff.org/) for automated changelog ge
30
39
```
31
40
This creates a GitHub release titled `nightshade-vX.Y.Z` with the full changelog as release notes.
32
41
42
+
## Pre-1.0 Versioning
43
+
44
+
While Nightshade is in pre-1.0 development (0.x.x versions), semantic versioning is interpreted differently:
45
+
46
+
-**Patch version (0.x.Y)**: Bug fixes, minor changes, and breaking changes
47
+
-**Minor version (0.X.0)**: New features, improvements, and breaking changes
48
+
-**Major version (X.0.0)**: Reserved for the 1.0 stable release
49
+
50
+
During pre-1.0 development, breaking changes may occur in both patch and minor version bumps. Once version 1.0 is reached, standard semantic versioning will apply where breaking changes require a major version bump.
0 commit comments