diff --git a/CHANGELOG.md b/CHANGELOG.md index 12e3d5073..59a3560ca 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -68,6 +68,7 @@ VS Code v1.56 ### Documentation - docs(install): add raspberry pi section #3376 @jsjoeio +- docs(maintaining): add pull requests section #3378 @jsjoeio ### Development diff --git a/docs/MAINTAINING.md b/docs/MAINTAINING.md index eb2be4af2..d65eb3e1f 100644 --- a/docs/MAINTAINING.md +++ b/docs/MAINTAINING.md @@ -8,6 +8,7 @@ - [Triage](#triage) - [Project Boards](#project-boards) - [Versioning](#versioning) + - [Pull Requests](#pull-requests) @@ -63,3 +64,9 @@ 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.