Contributions to rq are very welcome; please track contributions via
the issue tracker.
All issues are marked as either Bugs or Issues. They can also be
tagged with an experience level E- which is one of E-easy,
E-medium, E-hard, E-mentor and the most likely languages
involved in the change L- which can be L-rust, L-js or L-c.
rq is not directly affiliated with Spotify but the project still
adheres to its
code of conduct.
rq is mostly written in the Rust programming language.
Assuming that you have nothing installed, the easiest way to set
things up is to use rustup (see rustup.rs
for more info):
curl -sSLf https://sh.rustup.rs | sh
The Rust installer will give you further platform-specific instructions (e.g. if you're missing other development tools).
You will need the clang development libraries. On a Debian based Linux system, you can get those like this:
sudo apt install libclang-dev clang
To build rq, navigate to the source directory.
You will need a build of the V8 JavaScript engine as well. If your operating system package manager doesn't provide a package, you can download a build like this:
wget "https://s3-eu-west-1.amazonaws.com/record-query/v8/$TARGET/5.7.441.1/v8-build.tar.gz"
tar -xvf v8-build.tar.gz
export V8_LIBS=$PWD/v8-build/lib/libv8uber.a
export V8_SOURCE=$PWD/v8-build
Now you can run the tests for the project (including JSDoc tests):
cargo test
A debug build of the executable can be created like so:
cargo build
It will be available in target/debug/rq.
A release build can be created like so (might take a lot longer):
cargo build --release
It will be available in target/release/rq.
The easiest way to create cross-compiled builds is to use the ./ci script.
Look in the Travis build config for available parameters. For example:
TARGET=x86_64-unknown-linux-gnu USE_DOCKER=true ./ci test
TARGET=x86_64-unknown-linux-gnu USE_DOCKER=true ./ci deploy