You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+5-9
Original file line number
Diff line number
Diff line change
@@ -93,12 +93,7 @@ If you don't already have [Git] installed, install it first. You will need it to
93
93
```bash
94
94
npm run build
95
95
```
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]
102
97
103
98
## Linting, Building, and Testing
104
99
@@ -119,14 +114,16 @@ To compile the TypeDoc source, run `npm run build`. This will start the TypeScri
119
114
TypeDoc includes an extensive set of tests that describe its output. To validate any changes you have made run `npm test`.
120
115
This will run a subset of TypeDoc's tests intended for quick development checks.
121
116
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.
124
117
125
118
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.
126
119
127
120
Additional tests are contained within the `converter2` directory that look for specific issues with previous
128
121
builds and may be more appropriate for adding a testfor a bugfix.
129
122
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
+
130
127
## Pull Requests
131
128
132
129
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
0 commit comments