Thank you for your interest in contributing to this project!
Issues for bug reports, feature requests and others are all welcome!
Pull requests of any kind are welcome too. However, please note that we might not always be able to accept feature contributions as-is. Added feature should match nitrogql's goals.
See below for how to set up development environment.
New features may require corresponding documentation updates. Documentation updates accompanying feature contribution is very appreciated, but it is not necessary. A maintainer can supplement the needed documentation.
Below are instructions for setting up your development environment.
This project is written in Rust. You will need to install Rust and Cargo to build this project. You can find instructions for installing Rust here.
Also, this project maintains Node.js integrations. You will need to install Node.js and npm to build the Node.js integrations. You can find instructions for installing Node.js here.
Usual commands like cargo build, cargo test or cargo watch (you need cargo-watch for this) should work.
When you want to update snapshot tests, cargo-insta is required. Instead of cargo test, run cargo insta test for snapshot-testing-aware results. When snapshots are to be added or updated, run cargo insta review to review and apply the changes.
To generate coverage file, run make coverage. This will generate a coverage/lcov.info file which can be loaded by the Coverage Gutters extension.
Note that this requires below dependencies to be installed:
rustup component add llvm-tools-previewcargo install grcov
We have a small set of scripts for building the Node.js integration.
./build/build-rust.shto build Rust code into WASM../build/build-node.shto copy the WASM file into the Node.js packages.
For a production build, you need to have wasm-opt and wasm-snip installed.