Skip to content

Commit 0552967

Browse files
committed
wip: add maintaining docs
1 parent 85ded73 commit 0552967

File tree

3 files changed

+45
-1
lines changed

3 files changed

+45
-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

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
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+
# Maintaining
4+
5+
- [Maintaining](#maintaining)
6+
- [Workflow](#workflow)
7+
- [Milestones](#milestones)
8+
- [Project Boards](#project-boards)
9+
10+
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
11+
12+
# Maintaining
13+
14+
Current maintainers:
15+
16+
- @code-asher
17+
- @oxy
18+
- @jsjoeio
19+
20+
This document is meant to serve current and future maintainers of code-server, but also share openly our workflow for maintaining the project.
21+
22+
## Workflow
23+
24+
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.
25+
26+
### Milestones
27+
28+
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).
29+
30+
Here are the Milestones we use and how we use them:
31+
32+
- "Backlog" -> Work not yet planned for a specific release.
33+
- "On Deck" -> Work under consideration for upcoming milestones.
34+
- "Backlog Candidates" -> Work that is not yet accepted for the Backlog. We wait for the community to weigh in.
35+
- "<Month> <Year>" -> Work to be done that month.
36+
37+
### Project Boards
38+
39+
We use project boards sparingly.
40+
41+
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).
42+
43+
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)