Skip to content

Commit

Permalink
Update contribute.md
Browse files Browse the repository at this point in the history
  • Loading branch information
pubkey authored Jul 30, 2024
1 parent a91a7f6 commit 353ee98
Showing 1 changed file with 1 addition and 5 deletions.
6 changes: 1 addition & 5 deletions docs-src/docs/contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,7 @@ Before you can start developing, do the following:
1. Make sure you have installed nodejs with the version stated in the [.nvmrc](https://github.com/pubkey/rxdb/blob/master/.nvmrc)
2. Clone the repository `git clone https://github.com/pubkey/rxdb.git`
3. Install the dependencies `cd rxdb && npm install`
4. Make sure that the tests work for you `npm run test`

## Flow

While developing you should run `npm run dev` and leave it open in the console. This will run the unit-tests on every file-change. If you have a slow device, you can also manually run `npm run test:node` every time you want to check if the tests work.
4. Make sure that the tests work for you. At first, try it out with `npm run test:node:memory` which tests the memory storage in node. In the package.json you can find more scripts to run the tests with different storages.

## Adding tests

Expand Down

0 comments on commit 353ee98

Please sign in to comment.