Skip to content

Latest commit

 

History

History
32 lines (21 loc) · 1.16 KB

Contribute.md

File metadata and controls

32 lines (21 loc) · 1.16 KB

Contribution

RxDB is a very new project and as such relies on your contribution to be successful.

Run the tests

To make sure that RxDB runs as expected in every environment, it is important that many different developers run the tests.

  • clone this repository
  • npm install
  • npm test

If the tests don't succeed, run node and browser-tests seperat:

  • npm run test:node
  • npm run test:browser

Now you can submit a ticket with a description what has gone wrong, or even better, you can fix the issue by yourself.

Extend the example-projects

Feel free to add and extend the example-projects. This is very helpful for finding bugs when combining RxDB with different technologies.

Check out the pending features

Help here

Optimize the build-size

The builded javascript-file is very big. You can help by finding the big dependencies and optimizing how they get bundled.

Run npm run disc to find how big each dependency is.

Add features

You have a useful feature in mind that RxDB is missing? Create an issue to let other people implement it, or even implement it by yourself.