README.md's "Repository Structure" tree, which claims to show the full directory tree, omits the entire tracked brag-output/ directory (41 files)
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 85/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Domain
- documentation
Research direction
The issue is in README.md, in the 'Repository Structure' collapsible section. Locate the tree generation script or the markdown section that lists directories. Add 'brag-output/' to the list, following the same pattern as other summarized directories like 'results/figures/'. Verify the change by checking the rendered README and ensuring the directory is now included.
Written by the indexing model from the issue text.
Description
Where: README.md, the "Show the full directory tree →" collapsible section.
The gap: The tree lists every top-level file and directory in the repo (.github/, each audit folder, notebooks/, faircode/, tests/, results/, paper/, scripts/, explainers/, assets/, and the loose root files) but never mentions brag-output/, a real, currently-tracked directory containing 41 files (a rendered video, images, composition assets, fonts, SFX/music) that is genuinely part of the pushed repository, not local-only clutter:
$ git log --oneline -1 origin/main -- brag-output
04d5167 Added fair Code video
$ git ls-tree -r origin/main --name-only | grep -c "^brag-output/"
41
$ grep -n "brag-output\|brag" README.md
(no output - zero mentions)
This is the same bug class as the already-fixed #669 (repo-tree missing existing files like faircode/provenance.py and 9 test files), recurring for a directory added since.
Fix direction: Add a brag-output/ entry to the tree (collapsed/summarized the way results/figures/*.png and paper/results-frozen/figures/*.png already are), or, if it's considered out-of-scope generated marketing content that shouldn't be documented as part of the project's structure, note that exclusion explicitly rather than silently omitting a real, 41-file tracked directory from a section that claims completeness.
- Dominant language
- HTML
- Stars
- 47
- Forks
- 45
- Avg merge
- 1h 53m
- Merged PRs (30d)
- 97
Getting set up
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 yakew7/Fair-Code
-
bug documentation
Difficulty 1/5 Under an hour Newbie friendliness 95/100
Maintainers usually reply within 1 day
-
documentation good first issue
Difficulty 1/5 Under an hour Newbie friendliness 95/100
Maintainers usually reply within 1 day
-
documentation good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 92/100
yakew7/Fair-Code#731 · 1 comment ·
Maintainers usually reply within 1 day
-
bug documentation
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
enhancement help wanted
Difficulty 4/5 3-5 days Newbie friendliness 58/100
Maintainers usually reply within 1 day
All issues in yakew7/Fair-Code
Similar issues
-
sync-en
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
ACK_WAITING HELP_WANTED UPDATE_CS
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
OWASP/CheatSheetSeries#2458 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
l3montree-dev/devguard#3101 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
Maintainers usually reply within 1 day
-
area/documentation status/need-triage
Difficulty 1/5 Under an hour Newbie friendliness 95/100
google-gemini/gemini-cli#29548 ·
Maintainers usually reply within 1 day