Repository navigation
Rework README so the first screen explains the tool - #34
Merged
Merged
Conversation
Lead with a one-line pitch and a real three-trigger example, then install and usage. Trigger syntax tables now live only in docs/, scan rules move to docs/scanning.md, and the pipefail note moves to docs/ci.md.
|
Note Currently processing new changes in this PR. This may take a few minutes, please wait... ⚙️ Run configuration
📒 Files selected for processing: 5
✨ Finishing Touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Contributor
|
| Project | todo-by |
| Branch | docs-readme-ten-second-skim |
| Testbed | ubuntu-latest |
Click to view all benchmark results
| Benchmark | Latency | Benchmark Result milliseconds (ms) (Result Δ%) | Upper Boundary milliseconds (ms) (Limit %) |
|---|---|---|---|
| scan angular/angular | 📈 view plot 🚷 view threshold | 135.45 ms(+10.16%)Baseline: 122.96 ms | 153.70 ms (88.13%) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Context
The README's first screen didn't say what the tool is for. It opened with "Flag
todo-bytags whose deadline has passed, …", then two sections (Idea,What it's for) on the motivation, and the first example covered dates only. Install sat below all of that. The example was also wrong: it showed a.jsand a#comment, then printed a finding fromconfig/legacy.yml:42with a deadline that neither comment had.Further down, the README copied the version and issue syntax tables from
docs/versions.mdanddocs/issues.md, and gave one dense paragraph to scan rules (symlinks, VCS metadata, named paths).Solution
todo-by --onlinerun. I captured the output from a real run against a merged PR in this repo, then rewrote the issue line to a neutral#123inacme/app. The message format is unchanged.todo-by --helpfor the rest.IdeaandWhat it's forare merged into a shorterWhen to use it, placed after Usage.docs/versions.mdanddocs/issues.md. Dates keep their table, since no docs page covers them.docs/scanning.md. The README keeps a two-sentence summary. The| head/pipefailexit-code note moved todocs/ci.md.docs/scanning.md.Configuration, CI, prior art, and license are unchanged, apart from cutting the
version-cmddetail thatdocs/versions.mdalready covers.