MLH-Fellowship / MLH-Fellowship/orientation-project-python-24.SPR.A

Spell check on content added by user

Open
#11 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature stretch
Dominant language
Python
Stars
1
Forks
3
PR merge metrics
No merged PRs in 30d

Description

Be able to check that Experience, Education and Skill do not contain any spelling errors. This should be triggered by the user from the client. The format returned should follow this format:

[
    {
        "before": "Hellq there",
        "after": "Hello there"
    }
]

If a better format can be found, this must be discussed with your Pod Leader to make sure the fellows contributing to the JavaScript repository can build functionality to match it.

This should include a test in test_pytest.py to show that it works correctly.

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.

Research direction

Start with test_pytest.py and the issue's JSON example, then trace how Experience, Education and Skill content can be checked when requested by the client. Done means spelling-check results follow the stated before/after structure, or an agreed alternative, and the behavior is covered by the test.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, python
Domain
backend, content
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.