Merge pull request #3288 from cdr/jsjoeio/document-versioning

docs(maintaining): add versioning
This commit is contained in:
repo-ranger[bot] 2021-05-04 23:03:29 +00:00 committed by GitHub
commit 2a4c14f315
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 0 deletions

View File

@ -7,6 +7,7 @@
- [Milestones](#milestones)
- [Triage](#triage)
- [Project Boards](#project-boards)
- [Versioning](#versioning)
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
@ -56,3 +57,9 @@ We use project boards for projects or goals that span multiple milestones.
Think of this as a place to put miscellaneous things (like testing, clean up stuff, etc). As a maintainer, random todos may come up here and there. This gives you a place to add notes temporarily before opening a new issue. Given that our release milestones function off of issues, we believe tasks should have dedicated issues.
It also gives us a way to separate the issue triage from bigger-picture, long-term work.
## Versioning
`<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.