Skip to content

Commit b9989ca

Browse files
committed
docs(MAINTAINING): add Testing section
1 parent 4e310b4 commit b9989ca

File tree

2 files changed

+29
-16
lines changed

2 files changed

+29
-16
lines changed

docs/CONTRIBUTING.md

+14-16
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,21 @@
11
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
22
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
3-
43
# Contributing
54

6-
- [Contributing](#contributing)
7-
- [Requirements](#requirements)
8-
- [Creating pull requests](#creating-pull-requests)
9-
- [Commits and commit history](#commits-and-commit-history)
10-
- [Development workflow](#development-workflow)
11-
- [Updates to VS Code](#updates-to-vs-code)
12-
- [Build](#build)
13-
- [Test](#test)
14-
- [Unit tests](#unit-tests)
15-
- [Script tests](#script-tests)
16-
- [Integration tests](#integration-tests)
17-
- [End-to-end tests](#end-to-end-tests)
18-
- [Structure](#structure)
19-
- [Modifications to VS Code](#modifications-to-vs-code)
20-
- [Currently Known Issues](#currently-known-issues)
5+
- [Requirements](#requirements)
6+
- [Creating pull requests](#creating-pull-requests)
7+
- [Commits and commit history](#commits-and-commit-history)
8+
- [Development workflow](#development-workflow)
9+
- [Updates to VS Code](#updates-to-vs-code)
10+
- [Build](#build)
11+
- [Test](#test)
12+
- [Unit tests](#unit-tests)
13+
- [Script tests](#script-tests)
14+
- [Integration tests](#integration-tests)
15+
- [End-to-end tests](#end-to-end-tests)
16+
- [Structure](#structure)
17+
- [Modifications to VS Code](#modifications-to-vs-code)
18+
- [Currently Known Issues](#currently-known-issues)
2119

2220
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
2321

docs/MAINTAINING.md

+15
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
- [Docker](#docker)
2020
- [Homebrew](#homebrew)
2121
- [npm](#npm)
22+
- [Testing](#testing)
2223
- [Documentation](#documentation)
2324
- [Troubleshooting](#troubleshooting)
2425

@@ -214,6 +215,20 @@ We publish code-server as a npm package [here](https://www.npmjs.com/package/cod
214215

215216
This is currently automated with the release process.
216217

218+
## Testing
219+
220+
Our testing structure is laid out under our [Contributing docs](https://coder.com/docs/code-server/latest/CONTRIBUTING#test).
221+
222+
We hope to eventually hit 100% test converage with our unit tests, and maybe one day our scripts (coverage not tracked currently).
223+
224+
If you're ever looking to add more tests, here are a few ways to get started:
225+
226+
- run `yarn test:unit` and look at the coverage chart. You'll see all the uncovered lines. This is a good place to start.
227+
- look at `test/scripts` to see which scripts are tested. We can always use more tests there.
228+
- look at `test/e2e`. We can always use more end-to-end tests.
229+
230+
Otherwise, talk to a current maintainer and ask which part of the codebase is lacking most when it comes to tests.
231+
217232
## Documentation
218233

219234
### Troubleshooting

0 commit comments

Comments
 (0)