LukeMathWalker / LukeMathWalker/cheadergen

add --check mode

Open
#28 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
34
Forks
4
PR merge metrics
No merged PRs in 30d

Description

It would be nice to have a `--check` command line option, similar to `cargo fmt --check`, one could use in CI to ensure the committed generated headers are up to date.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the existing command-line entry point and follow the header-generation path used by cheadergen. Compare the desired behavior with cargo fmt --check, then verify that --check detects out-of-date committed headers and succeeds when they are current. Run the repository's existing checks after exercising both cases.

Written by the indexing model from the issue text.

Assessment

Tech stack
c, rust
Domain
build-system, cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
67/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.