Audit the Go codebase

Open
#2 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Refactor
Clarity
Mostly clear
Activity status
Quiet
Tech stack
go
Domain
cli, security, testing, tooling

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.

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), the SetContentProperty retry, attachment sync, pagination.
  • Config (internal/client.Resolve) and the .env reader.
  • 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.

Dominant language
Go
Stars
2
Forks
0
Avg merge
2h 5m
Merged PRs (30d)
50

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from mozilla/markfluence

All issues in mozilla/markfluence

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.