Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 2dcb91c

Browse files
committedMay 25, 2021
docs: add changelog to MAINTAINING.md
1 parent 66cabab commit 2dcb91c

File tree

2 files changed

+34
-9
lines changed

2 files changed

+34
-9
lines changed
 

‎CHANGELOG.md

Lines changed: 25 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,24 @@
33
# Changelog
44

55
- [Changelog](#changelog)
6-
- [Next Version](#next-version)
7-
- [Documentation](#documentation)
8-
- [3.10.2](#3102)
6+
- [Next Version](#next-version)
97
- [New Features](#new-features)
108
- [Bug Fixes](#bug-fixes)
9+
- [Documentation](#documentation)
1110
- [Development](#development)
12-
- [3.10.1](#3101)
11+
- [3.10.2](#3102)
12+
- [New Features](#new-features-1)
1313
- [Bug Fixes](#bug-fixes-1)
14-
- [Documentation](#documentation-1)
1514
- [Development](#development-1)
16-
- [3.10.0](#3100)
17-
- [New Features](#new-features-1)
15+
- [3.10.1](#3101)
1816
- [Bug Fixes](#bug-fixes-2)
19-
- [Documentation](#documentation-2)
17+
- [Documentation](#documentation-1)
2018
- [Development](#development-2)
19+
- [3.10.0](#3100)
20+
- [New Features](#new-features-2)
21+
- [Bug Fixes](#bug-fixes-3)
22+
- [Documentation](#documentation-2)
23+
- [Development](#development-3)
2124
- [Previous versions](#previous-versions)
2225

2326
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
@@ -57,13 +60,26 @@ VS Code v0.00.0
5760
5861
-->
5962

60-
# Next Version
63+
## Next Version
6164

6265
VS Code v0.00.0
6366

67+
### New Features
68+
69+
- item
70+
71+
### Bug Fixes
72+
73+
- item
74+
6475
### Documentation
6576

6677
- docs: fix confusing sentence in pull requests section #3460 @shiv-tyagi
78+
- docs(MAINTAINING): add information about CHANGELOG #3467 @jsjoeio
79+
80+
### Development
81+
82+
- item
6783

6884
## 3.10.2
6985

‎docs/MAINTAINING.md

Lines changed: 9 additions & 0 deletions
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)
Please sign in to comment.