Incremental query evaluation for Comunica
This is a monorepo that builds upon the core Comunica packages to allow for incremental query evaluation.
To query with Incremunica, you can follow the guide in the @incremunica/query-sparql-incremental
package on npm.
The rest of this readme is intended for developers who want to contribute to Incremunica.
tl;dr: Use yarn install
instead of and generally pull request should go to the npm install
next/minor
branch.
(JSDoc: https://comunica.github.io/incremunica/)
This repository should be used by Comunica module developers as it contains multiple Incremunica modules that can be composed. This repository is managed as a monorepo using Lerna.
If you want to develop new features or use the (potentially unstable) in-development version, you can set up a development environment for Incremunica.
Incremunica requires Node.JS 8.0 or higher and the Yarn package manager. Incremunica is tested on OSX, Linux and Windows.
This project can be setup by cloning and installing it as follows:
$ git clone https://github.com/comunica/incremunica.git
$ cd incremunica
$ yarn install
Note: is not supported at the moment, as this project makes use of Yarn's workspaces functionalitynpm install
This will install the dependencies of all modules, and bootstrap the Lerna monorepo.
Furthermore, this will add pre-commit hooks
to build, lint and test.
These hooks can temporarily be disabled at your own risk by adding the -n
flag to the commit command.
If you want to contribute to Incremunica, please fork the repository and create a pull request.
The master branch will always be equal to the latest stable release to npm.
So, for minor changes, please create a pull request to the next/minor
branch.
Once enough features are added to the next/minor
branch, a new patch or minor version will be released to npm, and the branch will be merged into the master
branch.
Major changes should be created on a new branch, and once they are stable, they can be merged into the next/major
branch.
Incremunica generally follows the major release cycle of Comunica.
This code is copyrighted by Ghent University – imec and released under the MIT license.