From 5660dba09bd3c93e320a8c8171afa468d3f5c112 Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Wed, 12 May 2021 15:47:41 -0700 Subject: [PATCH] docs(maintaining): add merge strategies section --- docs/MAINTAINING.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/MAINTAINING.md b/docs/MAINTAINING.md index eb2be4af23c1..6dc27523dd73 100644 --- a/docs/MAINTAINING.md +++ b/docs/MAINTAINING.md @@ -8,6 +8,8 @@ - [Triage](#triage) - [Project Boards](#project-boards) - [Versioning](#versioning) + - [Pull Requests](#pull-requests) + - [Merge Strategies](#merge-strategies) @@ -63,3 +65,13 @@ It also gives us a way to separate the issue triage from bigger-picture, long-te `` 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. + +## Pull Requests + +Ideally, every PR should fix an issue. If it doesn't, make sure it's associated with a version milestone. + +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. + +### Merge Strategies + +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.