The performance README points to a measure script at the wrong path
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 92/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- shell
- Domain
- documentation
Research direction
Start with docs/benchmarks/performance/README.md:10 and the example at docs/benchmarks/performance/measure-cli.sh:7. From the repository root, run both documented --help commands and confirm they print the script usage; done means both examples resolve the existing script path and the documentation check passes.
Written by the indexing model from the issue text.
Description
Found on santos/dev2 at 008363c98 (#1410). On dev@debffabf6 too.
What happened
The documented command names docs/benchmarks/measure-cli.sh, which does not exist. The executable is docs/benchmarks/performance/measure-cli.sh. The same stale path is on dev.
Replication
Deterministic (no model). From a clean checkout, run the README's path with --help. The shell reports that the file does not exist. Run docs/benchmarks/performance/measure-cli.sh --help; it prints usage.
Where
docs/benchmarks/performance/README.md:10 contains the stale command. The script's own example at docs/benchmarks/performance/measure-cli.sh:7 also uses the stale path, at 008363c98.
The fix
Use the existing performance/measure-cli.sh path in both examples.
Acceptance
- e2e: both documented
--helpcommands execute from the repository root and print the script's usage. - Unit: a documentation check resolves every local script path in these examples.
- The change entry's
invalidatesnames the former path.
- Dominant language
- Go
- Stars
- 115
- Forks
- 14
- Avg merge
- 9h 38m
- Merged PRs (30d)
- 730
Contributor guide
No contributing guide indexed for this repository
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.
More from Agent-Field/CodeAF
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Agent-Field/CodeAF#1489 ·
-
area:chat bug good first issue sev:papercut
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Agent-Field/CodeAF#1470 ·
-
area:chat bug good first issue sev:papercut
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Agent-Field/CodeAF#1469 ·
-
area:chat bug sev:papercut
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
Agent-Field/CodeAF#1468 ·
-
area:tests bug hygiene sev:papercut
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Agent-Field/CodeAF#1460 ·
All issues in Agent-Field/CodeAF
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
bazel-contrib/rules_go#4726 · 1 comment ·
-
area/auto-scaling area/monitoring area/ops-productivity kind/enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Type/Improvement
Difficulty 1/5 1-3 hours Newbie friendliness 90/100
OpenNSW/nsw-srilanka#522 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 92/100