Skip to content

feat: add spellcheck endpoint and tests for resume content (fix #11)#38

Merged
JocelynVelarde merged 2 commits into
MLH-Fellowship:mainfrom
aboderinsamuel:main
Jun 2, 2026
Merged

feat: add spellcheck endpoint and tests for resume content (fix #11)#38
JocelynVelarde merged 2 commits into
MLH-Fellowship:mainfrom
aboderinsamuel:main

Conversation

@aboderinsamuel

Copy link
Copy Markdown
Member

Summary

This PR implements spell checking for user-provided resume content (Experience, Education, and Skill) and exposes it via a new endpoint for client-triggered checks.

Related Issue

What’s Included

  • New /resume/spellcheck GET endpoint that scans the existing in-memory resume data and returns spelling corrections.
  • Response format matches the agreed structure:
    [
    { "before": "Teh dog", "after": "The dog" }
    ]
  • Spellcheck logic is applied to key text fields:
    • Experience: title, company, description
    • Education: course, school
    • Skill: name, proficiency
  • Added deterministic pytest that verifies a known misspelling is corrected.
  • Added dependency: pyspellchecker.

Implementation Details

  • Spellcheck is implemented with pyspellchecker.
  • Corrections preserve capitalization (uppercase and title case).
  • Only entries that actually change are returned.

Testing

  • pytest test_pytest.py

Notes / Follow‑ups

  • If the API response format needs richer metadata (e.g., field name, index), it should be aligned with the JavaScript client and agreed with the Pod Leader before changes.

@aboderinsamuel aboderinsamuel changed the title Add spellcheck endpoint and tests for resume content (fix #11) feat: add spellcheck endpoint and tests for resume content (fix #11) May 26, 2026
@JocelynVelarde

Copy link
Copy Markdown
Member

hey there please resolve the merge conflicts @aboderinsamuel

@JocelynVelarde JocelynVelarde merged commit 9d78605 into MLH-Fellowship:main Jun 2, 2026
2 checks passed
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.

2 participants