a
/
code-server
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs(MAINTAINING): add Testing section

This commit is contained in:
Joe Previte 2021-09-29 14:59:17 -07:00
parent 4e310b4985
commit b9989ca2db
No known key found for this signature in database
GPG Key ID: 2C91590C6B742C24
2 changed files with 29 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
docs/CONTRIBUTING.md
View File

@ -1,23 +1,21 @@
<!-- START doctoc generated TOC please keep comment here to allow auto update --> <!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
# Contributing # Contributing
- [Contributing](#contributing) - [Requirements](#requirements)
- [Requirements](#requirements) - [Creating pull requests](#creating-pull-requests)
- [Creating pull requests](#creating-pull-requests) - [Commits and commit history](#commits-and-commit-history)
- [Commits and commit history](#commits-and-commit-history) - [Development workflow](#development-workflow)
- [Development workflow](#development-workflow) - [Updates to VS Code](#updates-to-vs-code)
- [Updates to VS Code](#updates-to-vs-code) - [Build](#build)
- [Build](#build) - [Test](#test)
- [Test](#test) - [Unit tests](#unit-tests)
- [Unit tests](#unit-tests) - [Script tests](#script-tests)
- [Script tests](#script-tests) - [Integration tests](#integration-tests)
- [Integration tests](#integration-tests) - [End-to-end tests](#end-to-end-tests)
- [End-to-end tests](#end-to-end-tests) - [Structure](#structure)
- [Structure](#structure) - [Modifications to VS Code](#modifications-to-vs-code)
- [Modifications to VS Code](#modifications-to-vs-code) - [Currently Known Issues](#currently-known-issues)
- [Currently Known Issues](#currently-known-issues)
<!-- END doctoc generated TOC please keep comment here to allow auto update --> <!-- END doctoc generated TOC please keep comment here to allow auto update -->

15
docs/MAINTAINING.md
View File

@ -19,6 +19,7 @@
- [Docker](#docker) - [Docker](#docker)
- [Homebrew](#homebrew) - [Homebrew](#homebrew)
- [npm](#npm) - [npm](#npm)
- [Testing](#testing)
- [Documentation](#documentation) - [Documentation](#documentation)
- [Troubleshooting](#troubleshooting) - [Troubleshooting](#troubleshooting)
@ -214,6 +215,20 @@ We publish code-server as a npm package [here](https://www.npmjs.com/package/cod
This is currently automated with the release process. This is currently automated with the release process.
## Testing
Our testing structure is laid out under our [Contributing docs](https://coder.com/docs/code-server/latest/CONTRIBUTING#test).
We hope to eventually hit 100% test converage with our unit tests, and maybe one day our scripts (coverage not tracked currently).
If you're ever looking to add more tests, here are a few ways to get started:
- run `yarn test:unit` and look at the coverage chart. You'll see all the uncovered lines. This is a good place to start.
- look at `test/scripts` to see which scripts are tested. We can always use more tests there.
- look at `test/e2e`. We can always use more end-to-end tests.
Otherwise, talk to a current maintainer and ask which part of the codebase is lacking most when it comes to tests.
## Documentation ## Documentation
### Troubleshooting ### Troubleshooting