Audit the Go codebase
Open
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 2
- Forks
- 0
- Avg merge
- 2h 8m
- Merged PRs (30d)
- 49
Description
Do a focused review pass over the Go codebase before wider use.
Areas:
- Converter (
internal/convert): shield sentinel round-trip edge cases, attribute/text escaping, RE2 slug behavior vs. GitHub, callout detection, image/link rewriting corners. - Client (
internal/client): timeouts, error wrapping (HTTPError), theSetContentPropertyretry, attachment sync, pagination. - Config (
internal/client.Resolve) and the.envreader. - Error handling / exit codes across the commands.
- Test coverage gaps (client and convert especially).
- Idiomatic Go review.
Consider adding govulncheck and expanding the golangci-lint set. Deliverable: findings + follow-up issues.
Contributor 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.
Research direction
Start by reviewing internal/convert and internal/client, including internal/client.Resolve and the .env reader, then trace error handling and exit codes across the commands. Check existing client and convert test coverage, and consider the mentioned govulncheck and golangci-lint additions. Done means recording findings and creating follow-up issues.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- cli, security, testing, tooling
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100