Skip to content

Commit 16f64d9

Browse files
committed
docs: split wiki content appropriately
- Move 'Developing mocha' wiki content to .github/DEVELOPMENT.md - Keep 'Using Mocha programmatically' in public docs
1 parent 89f7c0d commit 16f64d9

File tree

3 files changed

+19
-68
lines changed

3 files changed

+19
-68
lines changed

.github/DEVELOPMENT.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,22 @@ If you are having trouble, don't be afraid to [ask for help](./CONTRIBUTING.md#
1616
- Do not use `yarn install` or `pnpm install`.
1717
- Some optional dependencies may fail; you can safely ignore these unless you are trying to build the documentation.
1818
- If you're sick of seeing the failures, run `npm install --ignore-scripts`.
19+
20+
## Developing Mocha
21+
22+
When you contribute to mocha, you will probably want to try to run your changes on the test suite of another project. You can (and should) run the test suite of mocha itself before committing, but also confirming that your changes give the expected result on another project.
23+
24+
For example, [WebSocket.io](https://github.com/LearnBoost/websocket.io/):
25+
26+
$ git clone https://github.com/LearnBoost/websocket.io.git
27+
28+
Retreive websocket.io's dependencies, which will include the stable version of mocha:
29+
30+
$ cd websocket.io/
31+
$ npm install
32+
33+
Replace the mocha dependency by the current git repository:
34+
35+
$ cd node_modules/
36+
$ mv mocha/ mocha.save
37+
$ git clone https://github.com/visionmedia/mocha.git

docs-next/src/content/docs/explainers/developing-mocha.mdx

Lines changed: 0 additions & 36 deletions
This file was deleted.

docs/api-tutorials/developing-mocha.md

Lines changed: 0 additions & 32 deletions
This file was deleted.

0 commit comments

Comments
 (0)