Skip to content

Latest commit

 

History

History
30 lines (19 loc) · 1.05 KB

CONTRIBUTING.md

File metadata and controls

30 lines (19 loc) · 1.05 KB

Contributing code

  • Run make precommit or make check if using nix flakes

Dev Install

Dev Containers

Install docker, vscode and the Dev Containers Extension

git clone

Ctrl+Shift+P Dev Containers: Open Folder in Container

Run code with F5 or cargo run

Run tests with nix flake check or cargo t

Docker Compose

git clone

make up-surrealdb.dev

Remove the cargo cache for buildkit with docker builder prune --filter type=exec.cachemount

View Progress

make view

License

All code in this repository is dual-licensed under either License-MIT or LICENSE-APACHE at your option. This means you can select the license you prefer. Why dual license.

Your contributions

Any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.