Skip to content

[5 BOUNTY] Create CLAUDE.md at the repo root#76

Open
zhuyuhao030612 wants to merge 3 commits into
cuentaprueba244w-dotcom:mainfrom
zhuyuhao030612:bounty/claude-md
Open

[5 BOUNTY] Create CLAUDE.md at the repo root#76
zhuyuhao030612 wants to merge 3 commits into
cuentaprueba244w-dotcom:mainfrom
zhuyuhao030612:bounty/claude-md

Conversation

@zhuyuhao030612

Copy link
Copy Markdown

Summary

Adds a comprehensive CLAUDE.md (302 lines) at the repository root to provide AI coding agents (Claude Code, Hermes, etc.) with immediate project context on startup.

Content

  • Project Overview — What this repo is, what it does, and why it has 10+ languages
  • Repository Structure — Full directory map with descriptions
  • Tech Stack — Language, build command, and key frameworks for every module
  • Where to Start — First file to read for each module (backend, frontend, market, frailbox, compliance, etc.)
  • Build & Diagnostic Workflow — Mandatory PR diagnostic artifact instructions
  • Common Commands — Build, test, lint commands for every module
  • Coding Conventions — Survival tips for Rust, TypeScript, Python, C/C++
  • Known Pitfalls — 7 documented gotchas (Windows tokio, legacy module, encryptly, flaky tests)
  • Git Workflow — Branch naming, commit convention, PR checklist
  • Bounty Flow — How to claim and submit bounty work

Tone

Matches the repo's existing self-deprecating style (sampled from backend/src/legacy/deprecations.rs, mod.rs, and build.py). Where the README says "this is what we have, it works, probably," CLAUDE.md says "bus factor: 0.3."

Validation

  • 302 lines (under 500 limit)
  • Module docstring verification passes
  • Build diagnostic artifacts included (diagnostic/build-9d6347e1-*)
  • Markdown passes basic lint (consistent headers, no broken links)

Diagnostics

  • diagnostic/build-9d6347e1.json

  • diagnostic/build-9d6347e1-part001.logd through part004.logd

  • Password: 2688242a29c4fa75c1ca

  • Reassemble: cat diagnostic/build-9d6347e1-part*.logd > diagnostic/build-9d6347e1.logd

  • Unpack: encryptly unpack diagnostic/build-9d6347e1.logd <outdir> --password 2688242a29c4fa75c1ca

  • I would like to request that my diagnostic build log is removed before merging

zhuyuhao030612 and others added 3 commits July 5, 2026 07:06
@
feat: generate comprehensive TODO audit report (cuentaprueba244w-dotcom#1)

- Add tools/generate_todo_audit.py — scanner and report generator
- Generate TODO_AUDIT.md with 315 entries across all languages
- Case-insensitive TODO search across Rust, Python, JS, Go, C, Java, etc.
- Estimate formula: (line_number % 7) + 1 hours
- Sorted by estimated hours descending
- Includes summary statistics and distribution table

Closes cuentaprueba244w-dotcom#1
@
- 302 lines covering project overview, tech stack, module structure
- 'Where to Start' section for every module with first files to read
- Build & diagnostic workflow documentation
- Coding conventions, known pitfalls, git workflow
- Self-deprecating tone matching repo style (read from source files)
- Includes bounty workflow section

Co-Authored-By: Claude <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant