Skip to content

docs: update CLAUDE.md and fix README.md typos#598

Merged
fclairamb merged 2 commits intomainfrom
docs/update-claude-md-and-readme
Jan 11, 2026
Merged

docs: update CLAUDE.md and fix README.md typos#598
fclairamb merged 2 commits intomainfrom
docs/update-claude-md-and-readme

Conversation

@fclairamb
Copy link
Copy Markdown
Owner

Summary

  • Rewrote CLAUDE.md with comprehensive documentation for AI assistants including project architecture, build commands, coding conventions, linter configuration, testing patterns, and common tasks
  • Fixed AVLB -> AVBL typo in README.md supported extensions list
  • Updated PassiveTransferPortRange type from *PortRange to PasvPortGetter in README.md to match actual code

Test plan

  • Verified README.md typo fixes match actual code in driver.go
  • Verified CLAUDE.md accurately reflects project structure and conventions

🤖 Generated with Claude Code

fclairamb and others added 2 commits January 11, 2026 16:43
- Rewrote CLAUDE.md with comprehensive documentation for AI assistants:
  - Detailed project architecture and file organization
  - Build, test, and lint commands
  - Coding conventions and design principles
  - Linter configuration details
  - Testing infrastructure and patterns
  - Common tasks (adding commands, extensions)
  - CI/CD workflow documentation

- Fixed README.md issues:
  - Corrected AVLB -> AVBL typo in supported extensions
  - Updated PassiveTransferPortRange type from *PortRange to PasvPortGetter

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@fclairamb fclairamb merged commit 5d78269 into main Jan 11, 2026
3 checks passed
@fclairamb fclairamb deleted the docs/update-claude-md-and-readme branch January 11, 2026 15:45
@codecov
Copy link
Copy Markdown

codecov Bot commented Jan 11, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 87.45%. Comparing base (3960a3a) to head (8c739ef).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #598   +/-   ##
=======================================
  Coverage   87.45%   87.45%           
=======================================
  Files          12       12           
  Lines        1770     1770           
=======================================
  Hits         1548     1548           
  Misses        148      148           
  Partials       74       74           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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