Skip to content

docs: Add instructions for local license header checks #84

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mileticveljko merged 1 commit into from
Feb 17, 2026
Merged

docs: Add instructions for local license header checks #84

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,17 @@ To ensure automatic code formatting, use [pre-commit](https://pre-commit.com/) a
pre-commit install
```

The `efc` project utilizes license header checks to ensure the _GPL-3.0_ license is applied to all source files. This process is automated via a GitHub Action using [Hawkeye](https://github.com/korandoru/hawkeye).

To **check locally** for missing license headers, run the following command (using a `podman` or `docker` container):
```bash
podman run -it --rm -v $PWD:/workspace -w /workspace ghcr.io/korandoru/hawkeye:latest check --config /workspace/licenserc.toml
Comment thread
DNedic marked this conversation as resolved.
```

To **automatically add** missing license headers, run:
```bash
podman run -it --rm -v $PWD:/workspace -w /workspace ghcr.io/korandoru/hawkeye:latest format --config /workspace/licenserc.toml
```
> Note: The `hawkeye format` command only prepends headers to files that lack them; it does not correct existing, incorrect headers. If a file has an incorrect header, you must manually delete it after the correct one is added.

When creating variables that represent physical units, unit suffixes must be added to their names (e.g. `pulse_duration_us`, `temp_degc`, `gyro_x_radps`).