Skip to content

Commit 7a8c659

Browse files
committed
docs: add maintaining.md with workflow
1 parent 9f7ceef commit 7a8c659

File tree

3 files changed

+49
-1
lines changed

3 files changed

+49
-1
lines changed

ci/dev/fmt.sh

+1
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ main() {
2727
doctoc --title '# Install' docs/install.md >/dev/null
2828
doctoc --title '# npm Install Requirements' docs/npm.md >/dev/null
2929
doctoc --title '# Contributing' docs/CONTRIBUTING.md >/dev/null
30+
doctoc --title '# Maintaining' docs/MAINTAINING.md >/dev/null
3031
doctoc --title '# Contributor Covenant Code of Conduct' docs/CODE_OF_CONDUCT.md >/dev/null
3132
doctoc --title '# iPad' docs/ipad.md >/dev/null
3233

docs/MAINTAINING.md

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
2+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
3+
4+
# Maintaining
5+
6+
- [Maintaining](#maintaining)
7+
- [Maintaining](#maintaining-1)
8+
- [Workflow](#workflow)
9+
- [Milestones](#milestones)
10+
- [Project Boards](#project-boards)
11+
12+
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
13+
14+
# Maintaining
15+
16+
Current maintainers:
17+
18+
- @code-asher
19+
- @oxy
20+
- @jsjoeio
21+
22+
This document is meant to serve current and future maintainers of code-server, but also share openly our workflow for maintaining the project.
23+
24+
## Workflow
25+
26+
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.
27+
28+
### Milestones
29+
30+
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).
31+
32+
Here are the milestones we use and how we use them:
33+
34+
- "Backlog" -> Work not yet planned for a specific release.
35+
- "On Deck" -> Work under consideration for upcoming milestones.
36+
- "Backlog Candidates" -> Work that is not yet accepted for the backlog. We wait for the community to weigh in.
37+
- "<0.0.0>" -> Work to be done for that version.
38+
39+
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.
40+
41+
### Project Boards
42+
43+
We use project boards for projects or goals that span multiple milestones.
44+
45+
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 without having to open a new issue (though that may be the better option — use your best judgement).
46+
47+
It also gives us a way to separate the issue triage from bigger-picture, long-term work.

test/unit/register.test.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { JSDOM } from "jsdom"
2-
import { loggerModule } from "../utils/helpers"
32
import { registerServiceWorker } from "../../src/browser/register"
3+
import { loggerModule } from "../utils/helpers"
44
import { LocationLike } from "./util.test"
55

66
describe("register", () => {

0 commit comments

Comments
 (0)