From d07317ad01feed3a31602e18f0dbcccec7a5173d Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Mon, 26 Apr 2021 14:26:16 -0700 Subject: [PATCH] docs: add maintaining.md with workflow --- ci/dev/fmt.sh | 1 + docs/MAINTAINING.md | 45 ++++++++++++++++++++++++++++++++++++++ test/unit/register.test.ts | 2 +- 3 files changed, 47 insertions(+), 1 deletion(-) create mode 100644 docs/MAINTAINING.md diff --git a/ci/dev/fmt.sh b/ci/dev/fmt.sh index ea898742..4f895357 100755 --- a/ci/dev/fmt.sh +++ b/ci/dev/fmt.sh @@ -27,6 +27,7 @@ main() { doctoc --title '# Install' docs/install.md >/dev/null doctoc --title '# npm Install Requirements' docs/npm.md >/dev/null doctoc --title '# Contributing' docs/CONTRIBUTING.md >/dev/null + doctoc --title '# Maintaining' docs/MAINTAINING.md >/dev/null doctoc --title '# Contributor Covenant Code of Conduct' docs/CODE_OF_CONDUCT.md >/dev/null doctoc --title '# iPad' docs/ipad.md >/dev/null diff --git a/docs/MAINTAINING.md b/docs/MAINTAINING.md new file mode 100644 index 00000000..13a1abe6 --- /dev/null +++ b/docs/MAINTAINING.md @@ -0,0 +1,45 @@ + + +# Maintaining + +- [Maintaining](#maintaining) + - [Workflow](#workflow) + - [Milestones](#milestones) + - [Project Boards](#project-boards) + + + +# Maintaining + +Current maintainers: + +- @code-asher +- @oxy +- @jsjoeio + +This document is meant to serve current and future maintainers of code-server, but also share openly our workflow for maintaining the project. + +## Workflow + +The workflow used by code-server maintainers is one that aims to be easy to understood by the community and easy enough for new maintainers to jump in and start contributing on day one. + +### Milestones + +We operate mainly using [milestones](https://github.com/cdr/code-server/milestones). This was heavily inspired by our friends over at [vscode](https://github.com/microsoft/vscode). + +Here are the milestones we use and how we use them: + +- "Backlog" -> Work not yet planned for a specific release. +- "On Deck" -> Work under consideration for upcoming milestones. +- "Backlog Candidates" -> Work that is not yet accepted for the backlog. We wait for the community to weigh in. +- "<0.0.0>" -> Work to be done for that version. + +With this flow, any un-assigned issues are essentially in triage state and once triaged 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. + +### Project Boards + +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. diff --git a/test/unit/register.test.ts b/test/unit/register.test.ts index b845aab5..106b9487 100644 --- a/test/unit/register.test.ts +++ b/test/unit/register.test.ts @@ -1,6 +1,6 @@ import { JSDOM } from "jsdom" -import { loggerModule } from "../utils/helpers" import { registerServiceWorker } from "../../src/browser/register" +import { loggerModule } from "../utils/helpers" import { LocationLike } from "./util.test" describe("register", () => {