Welcome for contributions!
Please, sign-off your commits (git commit -s) to license your contribution under Apache License 2.0.
First, follow the build guide and make sure that project is successfully build and development environment is properly configured.
config.proto is used to define configs for detectors. After making changes to proto file generate the code:
cargo xtask proto-gen
Use cargo fmt and cargo clippy to check your changes:
cargo clippy --workspace --all-features -- -D warnings
cargo fmt --all -- --check
cd bombini-detectors-ebpf
cargo clippy --workspace --all-features -- -D warnings
cargo fmt --all -- --checkThese checks can be performed automatically during commit using pre-commit.
Once the package is installed, simply run pre-commit install to enable the hooks, the checks will run automatically before the commit becomes effective.
Note: Please, do not stage vmlinux.rs file in commit.
After making changes check if tests are passing:
cargo xtask test --releaseTo add new tests, please, follow test writing guide.
If you make changes to Bombini configuration yaml files or events. The documentation must be updated. Please, follow the documentation guide.