Skip to content

Commit 5660dba

Browse files
committed
docs(maintaining): add merge strategies section
1 parent 800815f commit 5660dba

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

docs/MAINTAINING.md

+12
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@
88
- [Triage](#triage)
99
- [Project Boards](#project-boards)
1010
- [Versioning](#versioning)
11+
- [Pull Requests](#pull-requests)
12+
- [Merge Strategies](#merge-strategies)
1113

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

@@ -63,3 +65,13 @@ It also gives us a way to separate the issue triage from bigger-picture, long-te
6365
`<major.minor.patch>`
6466

6567
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.
68+
69+
## Pull Requests
70+
71+
Ideally, every PR should fix an issue. If it doesn't, make sure it's associated with a version milestone.
72+
73+
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.

0 commit comments

Comments
 (0)