Add `--check` option
Open
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 112
- Forks
- 2
- Avg merge
- 2h 52m
- Merged PRs (30d)
- 13
Description
Have --check spit out a diff with a nonzero exit code if the document isn't up to date, could be useful for ci workflows
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No files, tests, or entry points are named. Locate the CLI option parsing and document-generation entry points, then run the existing command on an up-to-date and modified document; done means --check shows a diff and returns nonzero only when the document is outdated.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- ci-cd, cli
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100