This document is meant to serve current and future maintainers of code-server, as well as share our workflow for maintaining the project.
The workflow used by code-server maintainers aims to be easy to understood by the community and easy enough for new maintainers to jump in and start contributing on day one.
Here are the milestones we use and how we use them:
With this flow, any un-assigned issues are essentially in triage state. Once triaged, issues are either "Backlog" or "Backlog Candidates". They will eventually move to "On Deck" (or be closed). Lastly, they will end up on a version milestone where they will be worked on.
We use the following process for triaging GitHub issues:
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 tasks may come up here and there. The project boards give you places to add temporary notes before opening a new issue. Given that our release milestones function off of issues, we believe tasks should have dedicated issues.
Project boards also give us a way to separate the issue triage from bigger-picture, long-term work.
The code-server project follows traditional semantic versioning, 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.
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 and the PR fixing the issue.
For most things, we recommend the squash and merge strategy. If you're
lib/vscode, we suggest using the rebase and merge strategy. There
may be times where creating a merge commit makes sense as well. Use your
best judgment. If you're unsure, you can always discuss in the PR with the team.
To save time when creating a new release for code-server, we keep a running
If either the author or reviewer of a PR believes the change should be mentioned in the changelog, then it should be added.
If there is not a Next Version when you modify
CHANGELOG.md, please add it
using the template you see near the top of the changelog.
When writing your changelog item, ask yourself:
If you need inspiration, we suggest looking at the Emacs changelog.
With each release, we rotate the role of release manager to ensure every maintainer goes through the process. This helps us keep documentation up-to-date and encourages us to continually review and improve the flow.
If you're the current release manager, follow these steps:
yarn release:prepand type in the new version (e.g.,
release-imagesartifacts. You do not have to wait for this step to complete before proceeding.
yarn release:github-draftto create a GitHub draft release from the template with the updated version.
v3.9.0 @ Target: v3.9.0
release-imagesartifacts to build.
yarn release:github-assetsto download the
release-packagesartifact. They will upload them to the draft release.
npm-package, and publish the Docker Hub image from
Our docs are hosted on Vercel. Vercel only shows logs in realtime, which means you need to have the logs open in one tab and reproduce your error in another tab. Since our logs are private to Coder the organization, you can only follow these steps if you're a Coder employee. Ask a maintainer for help if you need it.
Taking a real scenario, let's say you wanted to troubleshoot this docs change. Here is how you would do it: