Skip to content

Commit 4e310b4

Browse files
committed
docs(CONTRIBUTING): add scrip tests section
1 parent 1b80244 commit 4e310b4

File tree

1 file changed

+28
-16
lines changed

1 file changed

+28
-16
lines changed

docs/CONTRIBUTING.md

Lines changed: 28 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,23 @@
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+
34
# Contributing
45

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)
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)
1113
- [Test](#test)
12-
- [Unit tests](#unit-tests)
13-
- [Integration tests](#integration-tests)
14-
- [End-to-end tests](#end-to-end-tests)
15-
- [Structure](#structure)
16-
- [Modifications to VS Code](#modifications-to-vs-code)
17-
- [Currently Known Issues](#currently-known-issues)
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)
1821

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

@@ -129,13 +132,14 @@ yarn package
129132
> If you need your builds to support older distros, run the build commands
130133
> inside a Docker container with all the build requirements installed.
131134
132-
### Test
135+
## Test
133136

134-
There are three kinds of tests in code-server:
137+
There are four kinds of tests in code-server:
135138

136139
1. Unit tests
137-
2. Integration tests
138-
3. End-to-end tests
140+
2. Script tests
141+
3. Integration tests
142+
4. End-to-end tests
139143

140144
### Unit tests
141145

@@ -146,6 +150,14 @@ These live under [test/unit](../test/unit).
146150

147151
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.
148152

153+
### Script tests
154+
155+
Our script tests are written in bash and run using [bats](https://github.com/bats-core/bats-core).
156+
157+
These tests live under `test/scripts`.
158+
159+
We use these to test anything related to our scripts (most of which live under `ci`).
160+
149161
### Integration tests
150162

151163
These are a work in progress. We build code-server and run a script called

0 commit comments

Comments
 (0)