Skip to content

README honesty pass + add a Privacy section (data flow, cache, recruiter-mode legal note) #38

Description

@AdvancedUno

Problem

The README oversells what is actually fetched, and it has no privacy section at all — a serious gap for a tool that sends resume text to a third-party LLM and caches it on disk. Trust is this product's whole value proposition; over-claiming undermines it.

Concrete mismatches between README and code today:

Proposal

1. Honesty pass on the feature list. Rewrite the "multi-source fusion" bullet to state what is reliably fetched today (GitHub, portfolio/web, best-effort Scholar) vs. recorded-but-not-fetched (Codeforces/LeetCode handles) vs. resume-derived (arXiv/ORCID). Keep the roadmap items as roadmap.

2. Add a ## Privacy section covering:

  • Resume text is parsed by the selected LLM provider (Gemini by default) — treat it as data sent to that provider under their policy.
  • External signals are fetched locally and also sent to the LLM; nothing goes to a HireGauge server.
  • Responses are cached locally (default path once Security: candidate PII committed in .hireme_cache/ (HireMe -> HireGauge rename leftover) #16 lands); hiregauge cache clear wipes it; HIREGAUGE_CACHE_DIR overrides the location.
  • Recruiter mode (--mode recruiter) reframes output for a hiring reader — using it to evaluate other people is a regulated use (e.g. NYC Local Law 144 bias-audit, EU AI Act); the user is responsible for compliance.

3. Add a docs regression test in tests/test_docs.py asserting the README doesn't claim Codeforces/LeetCode stats are "fetched" until they are.

Acceptance criteria

  • Feature list matches implementation reality.
  • ## Privacy section added covering LLM data flow, local cache, and recruiter-mode legal note.
  • tests/test_docs.py guards against re-introducing the misleading "fetch(es) codeforces/leetcode" phrasing.

Files

  • README.md
  • tests/test_docs.py

Related: #9 (percentile honesty), #21, #7, #17 (recruiter mode).

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomerssecuritySecurity or privacy issue

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions