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: CONTRIBUTING.md
+12Lines changed: 12 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -123,6 +123,18 @@ Please consider the following when making a change:
123
123
124
124
* Check out the [Rust API Guidelines](https://rust-lang.github.io/api-guidelines/) for guidelines on designing the API.
125
125
126
+
## Tests
127
+
128
+
The main test harness is described in the [testsuite documentation](tests/testsuite/README.md). There are several different commands to run different kinds of tests:
129
+
130
+
- `cargo test --workspace` — This runs all of the unit and integration tests, except for the GUI tests.
131
+
- `cargo test --test gui` — This runs the [GUI test harness](#browser-compatibility-and-testing). This does not get run automatically due to its extra requirements.
132
+
- `npm run lint` — [Checks the `.js` files](#checking-changes-in-js-files)
133
+
- `cargo test --workspace --no-default-features` — Testing without default features helps check that all feature checks are implemented correctly.
134
+
- `cargo clippy --workspace --all-targets --no-deps -- -D warnings` — This makes sure that there are no clippy warnings.
135
+
- `RUSTDOCFLAGS="-D warnings" cargo doc --workspace --document-private-items --no-deps` — This verifies that there aren't any rustdoc warnings.
136
+
- `cargo fmt --check` — Verifies that everything is formatted correctly.
137
+
126
138
## Making a pull-request
127
139
128
140
When you feel comfortable that your changes could be integrated into mdBook, you can create a pull-request on GitHub.
0 commit comments