Skip to content

Commit 7be1ae3

Browse files
committed
docs(maintaining): add merge strategies section
1 parent fc894e4 commit 7be1ae3

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ VS Code v1.56
6969

7070
- docs(install): add raspberry pi section #3376 @jsjoeio
7171
- docs(maintaining): add pull requests section #3378 @jsjoeio
72+
- docs(maintaining): add merge strategies section #3379 @jsjoeio
7273

7374
### Development
7475

docs/MAINTAINING.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
- [Project Boards](#project-boards)
1010
- [Versioning](#versioning)
1111
- [Pull Requests](#pull-requests)
12+
- [Merge Strategies](#merge-strategies)
1213

1314
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
1415

@@ -63,10 +64,14 @@ It also gives us a way to separate the issue triage from bigger-picture, long-te
6364

6465
`<major.minor.patch>`
6566

66-
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.
67+
The code-server project follows traditional [semantic versioning](https://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.
6768

6869
## Pull Requests
6970

7071
Ideally, every PR should fix an issue. If it doesn't, make sure it's associated with a version milestone.
7172

7273
If a PR does fix an issue, don't add it to the version milestone. Otherwise, the version milestone will have duplicate information: the issue & the PR fixing the issue.
74+
75+
### Merge Strategies
76+
77+
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.

0 commit comments

Comments
 (0)