Skip to content

Commit 0e67ab7

Browse files
jsjoeioAkash Satheesan
and
Akash Satheesan
authored
docs: add changelog to MAINTAINING.md (#3467)
Co-authored-by: Akash Satheesan <[email protected]>
1 parent 8ed578b commit 0e67ab7

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

CHANGELOG.md

+13
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,23 @@ VS Code v0.00.0
3737

3838
VS Code v0.00.0
3939

40+
### New Features
41+
42+
- item
43+
44+
### Bug Fixes
45+
46+
- item
47+
4048
### Documentation
4149

4250
- docs: fix confusing sentence in pull requests section #3460 @shiv-tyagi
4351
- docs: remove toc from changelog @oxy @jsjoeio
52+
- docs(MAINTAINING): add information about CHANGELOG #3467 @jsjoeio
53+
54+
### Development
55+
56+
- item
4457

4558
## 3.10.2
4659

docs/MAINTAINING.md

+9
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
- [Versioning](#versioning)
1111
- [Pull Requests](#pull-requests)
1212
- [Merge Strategies](#merge-strategies)
13+
- [Changelog](#changelog)
1314
- [Release](#release)
1415
- [Release Manager Rotation](#release-manager-rotation)
1516

@@ -79,6 +80,14 @@ If a PR does fix an issue, don't add it to the version milestone. Otherwise, the
7980
For most things, we recommend "Squash and Merge". If you're updating `lib/vscode`, we suggest using the "Rebase and Merge" strategy. There may be times where "Create a merge commit" makes sense as well. Use your best judgement. If you're unsure, you can always discuss in the PR with the team.
8081
The code-server project follows traditional [semantic versioning](ttps://semver.org/), with the objective of minimizing major changes that break backward compatibility. We increment the patch level for all releases, except when the upstream Visual Studio Code project increments its minor version or we change the plugin API in a backward-compatible manner. In those cases, we increment the minor version rather than the patch level.
8182

83+
### Changelog
84+
85+
To save time when creating a new release for code-server, we keep a running changelog at `CHANGELOG.md`.
86+
87+
If either author or reviewer of a PR believe the change should be mentioned in the `CHANGELOG`, then it should be added.
88+
89+
If there is not a "Next Version" when you modify `CHANGELOG`, please add it using the template you see near the top of `CHANGELOG`. You can use the suggested format: `<pr title> <pr #> <author> Example: `fix: Check the logged user instead of $USER #3330 @videlanicolas`
90+
8291
## Release
8392

8493
### Release Manager Rotation

0 commit comments

Comments
 (0)