md-footer-template: "No markdown files found in project" when includes.global simply does not list .md
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 78/100
- Issue type
- Bug
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- typescript
- Domain
- tooling
Research direction
Start with findMarkdownFiles in md-footer-template.ts (lines 133–161) and the detectionLimits text in documentation-laws.ts (line 101). Trace how an empty result from includes.global is reported, then update the message to distinguish a filter that selects no Markdown files from a project with none. Done when the issue's example produces the clearer message.
Written by the indexing model from the issue text.
Description
Found in the 8.0.0 self-audit triage: RoC 7.29.1 (npm, 5fc54afe) on a clean clone of develop at 2d2fa9a, with typescript resolvable (verdict compliance, 0 failed / 46 warnings). The bucket method and per-law tables are kept by QA; counts are from that run.
What happens
findMarkdownFiles (md-footer-template.ts:133-161) applies includes.global. In a project whose includes list only code (src/**/*.ts, scripts/**/*.js, tests/**/*.ts) the law says "No markdown files found in project" although 7 markdown files are tracked. The card's detectionLimits line saying the law bypasses the configured ignore paths (documentation-laws.ts:101) is out of date.
Suggested direction
When the user's filter leaves nothing, report "nothing judged (includes.global selects no markdown)" rather than "the project has none".
- Dominant language
- TypeScript
- Stars
- 0
- Forks
- 0
- Avg merge
- 38m
- Merged PRs (30d)
- 96
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing 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.
More from Rule-Of-Code/RoC
-
bug
Difficulty 5/5 Over a week Newbie friendliness 35/100
Rule-Of-Code/RoC#439 · 1 comment ·
Maintainers usually reply within 1 day
-
bug
Difficulty 4/5 3-5 days Newbie friendliness 49/100
Rule-Of-Code/RoC#438 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 3/5 1-2 days Newbie friendliness 53/100
Rule-Of-Code/RoC#437 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 3/5 1-2 days Newbie friendliness 74/100
Rule-Of-Code/RoC#435 ·
Maintainers usually reply within 1 day
-
audit-invocation evidence: committed hooks, CI steps and `node dist/cli.js audit` are not recognisedOpenbug
Difficulty 4/5 3-5 days Newbie friendliness 55/100
Rule-Of-Code/RoC#434 ·
Maintainers usually reply within 1 day
All issues in Rule-Of-Code/RoC
Similar issues
-
documentation lens:human needs-triage
Difficulty 2/5 1-3 hours Newbie friendliness 73/100
thebristolsound/birdbrain#2246 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
bug ready-for-human
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
BoardGamesEmpire/board-games-empire-backend#1452 · 1 comment ·
Maintainers usually reply within 1 day
-
good first issue stretch
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Maintainers usually reply within 1 day