Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ include/
obj/
cpp/
pre-build.log
compile_commands.json
src/vg_git_version.hpp
src/vg_environment_version.hpp
*.o
Expand Down
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,17 @@ Ideally you would at least write your own unit tests.

New `.cpp` files will be auto-discovered by the build system.

### Editor and linter support

Tools like `clangd` need a `compile_commands.json` describing how each file is compiled. To make one, install [`compiledb`](https://github.com/nickdiego/compiledb) and then have the build generate it:

```bash
pipx install compiledb
make compile_commands.json
```

This builds vg's dependencies, if needed, but not vg itself.

### Command-line unit tests

We have a suite of Bash-TAP tests within `test/t/`. Run with `prove -v` for proper error handling.
Expand Down
Loading
Loading