diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md new file mode 100644 index 000000000..46cdef25e --- /dev/null +++ b/.github/copilot-instructions.md @@ -0,0 +1,16 @@ +# Repository Build & Test Instructions + +## Build Procedures +- **Required dependencies**: A C compiler (either clang or gcc) and a Go compiler. The Go compiler + should be at least the version mentioned in the go.mod file. +- **Bootstrap:** Always run `./dev.sh deps` to download all needed dependencies +- **Build command:** Run `./dev.sh build` to build the project + +## Test Procedures +- To run the complete test suite, run `./test.py` +- To run a specific test, run `./test.py test-name` t + `test-name` is the name of the test without the + leading `test_` for Python tests and without the leading `Test` for Go tests. + +## Benchmarking +- To run the benchmark: `./benchmark.py`