bughz
/
code-server
mirror of https://github.com/coder/code-server.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs(CONTRIBUTING): add scrip tests section

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

44
docs/CONTRIBUTING.md
View File

@ -1,20 +1,23 @@
<!-- 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
- [Requirements](#requirements) - [Contributing](#contributing)
- [Creating pull requests](#creating-pull-requests) - [Requirements](#requirements)
- [Commits and commit history](#commits-and-commit-history) - [Creating pull requests](#creating-pull-requests)
- [Development workflow](#development-workflow) - [Commits and commit history](#commits-and-commit-history)
- [Updates to VS Code](#updates-to-vs-code) - [Development workflow](#development-workflow)
- [Build](#build) - [Updates to VS Code](#updates-to-vs-code)
- [Build](#build)
- [Test](#test) - [Test](#test)
- [Unit tests](#unit-tests) - [Unit tests](#unit-tests)
- [Integration tests](#integration-tests) - [Script tests](#script-tests)
- [End-to-end tests](#end-to-end-tests) - [Integration tests](#integration-tests)
- [Structure](#structure) - [End-to-end tests](#end-to-end-tests)
- [Modifications to VS Code](#modifications-to-vs-code) - [Structure](#structure)
- [Currently Known Issues](#currently-known-issues) - [Modifications to VS Code](#modifications-to-vs-code)
- [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 -->
@ -129,13 +132,14 @@ yarn package
> If you need your builds to support older distros, run the build commands > If you need your builds to support older distros, run the build commands
> inside a Docker container with all the build requirements installed. > inside a Docker container with all the build requirements installed.
### Test ## Test
There are three kinds of tests in code-server: There are four kinds of tests in code-server:
1. Unit tests 1. Unit tests
2. Integration tests 2. Script tests
3. End-to-end tests 3. Integration tests
4. End-to-end tests
### Unit tests ### Unit tests
@ -146,6 +150,14 @@ These live under [test/unit](../test/unit).
We use unit tests for functions and things that can be tested in isolation. The file structure is modeled closely after `/src` so it's easy for people to know where test files should live. We use unit tests for functions and things that can be tested in isolation. The file structure is modeled closely after `/src` so it's easy for people to know where test files should live.
### Script tests
Our script tests are written in bash and run using [bats](https://github.com/bats-core/bats-core).
These tests live under `test/scripts`.
We use these to test anything related to our scripts (most of which live under `ci`).
### Integration tests ### Integration tests
These are a work in progress. We build code-server and run a script called These are a work in progress. We build code-server and run a script called