Skip to content

Commit b9177b4

Browse files
committed
Update contributing docs
Resolves #2815
1 parent 23008f6 commit b9177b4

File tree

1 file changed

+5
-9
lines changed

1 file changed

+5
-9
lines changed

.github/CONTRIBUTING.md

+5-9
Original file line numberDiff line numberDiff line change
@@ -93,12 +93,7 @@ If you don't already have [Git] installed, install it first. You will need it to
9393
```bash
9494
npm run build
9595
```
96-
1. Set up a baseline for visual theme testing:
97-
```bash
98-
npm run test:visual
99-
npm run test:visual:accept
100-
```
101-
1. Open the typedoc folder in your favorite editor. If you don't have one, try [Visual Studio Code][vscode] or [Atom]
96+
1. Open the typedoc folder in your favorite editor. If you don't have one, try [Visual Studio Code][vscode]
10297
10398
## Linting, Building, and Testing
10499
@@ -119,14 +114,16 @@ To compile the TypeDoc source, run `npm run build`. This will start the TypeScri
119114
TypeDoc includes an extensive set of tests that describe its output. To validate any changes you have made run `npm test`.
120115
This will run a subset of TypeDoc's tests intended for quick development checks.
121116
Tests which take more than half a second are located in `src/test/slow`, and will only be run if you run `npm run test:full`.
122-
These tests will also run the visual regression tests, failing if there are any changes.
123-
TypeDoc also contains visual regression tests for comparing changes made to the themes. To test this, run `npm run test:visual`. If there are changes that you expect, run `npm run test:visual:accept` to save the new baseline.
124117

125118
If you have changed the TypeDoc output, it will cause tests to fail. Once you have validated that the introduced changes were intended, run `npm run rebuild_specs` to update the spec files for the new output.
126119

127120
Additional tests are contained within the `converter2` directory that look for specific issues with previous
128121
builds and may be more appropriate for adding a test for a bugfix.
129122

123+
#### Visual Regression Testing
124+
125+
There is also a script to visually compare the differences between changes. To set this up, build the code, then run `node scripts/visual_regression.js`. This will create a baseline which future runs will be compared against after making changes, compiling, and running the visual regression script again.
126+
130127
## Pull Requests
131128

132129
Once you have finished working on an issue, you can submit a pull request to have your changes merged into the TypeDoc repository and included in the next release.
@@ -150,4 +147,3 @@ If the TypeDoc repository has changed since you originally forked it, you will n
150147
[git]: https://git-scm.com
151148
[node]: https://nodejs.org/en/
152149
[vscode]: https://code.visualstudio.com/
153-
[atom]: https://atom.io/

0 commit comments

Comments
 (0)