cubetiq/code-server
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs(maintaining): add merge strategies section

Browse Source
This commit is contained in:
Joe Previte 2021-05-12 15:47:41 -07:00
parent fc894e47fb
commit 7be1ae36a2
No known key found for this signature in database
GPG Key ID: 2C91590C6B742C24
2 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGELOG.md
View File

@ -69,6 +69,7 @@ VS Code v1.56
- docs(install): add raspberry pi section #3376 @jsjoeio - docs(install): add raspberry pi section #3376 @jsjoeio
- docs(maintaining): add pull requests section #3378 @jsjoeio - docs(maintaining): add pull requests section #3378 @jsjoeio
- docs(maintaining): add merge strategies section #3379 @jsjoeio
### Development ### Development

7
docs/MAINTAINING.md
View File

@ -9,6 +9,7 @@
- [Project Boards](#project-boards) - [Project Boards](#project-boards)
- [Versioning](#versioning) - [Versioning](#versioning)
- [Pull Requests](#pull-requests) - [Pull Requests](#pull-requests)
- [Merge Strategies](#merge-strategies)
<!-- END doctoc generated TOC please keep comment here to allow auto update --> <!-- END doctoc generated TOC please keep comment here to allow auto update -->
@ -63,10 +64,14 @@ It also gives us a way to separate the issue triage from bigger-picture, long-te
`<major.minor.patch>` `<major.minor.patch>`
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. 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.
## Pull Requests ## Pull Requests
Ideally, every PR should fix an issue. If it doesn't, make sure it's associated with a version milestone. 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. 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. If you're unsure, you can always discuss in the PR with the team.