Manual Reference Source

Contributing

Contributions to MiniSearch are welcome :) Just follow the guidelines below.

Bugs and feature requests

If you have an idea for a feature, or spotted a bug, please open an issue on GitHub.

Pull requests

Thinking about sending a pull request? That is great :) Here is how you can setup your development environment:

  1. Clone the repository
  2. Install the development dependencies with yarn install
  3. Run the tests with yarn test. You can also automatically trigger a run of relevant tests for the code that you change by running yarn test-watch
  4. If you are working on optimising the performance, you can run the performance benchmarks with yarn benchmark
  5. If you are improving the documentation, you can build the docs with yarn build-docs

In order to understand implementation details and design goals, read the design document.

Also, please follow these guidelines: