Improve documentation for recommendation scoring logic#27
Conversation
|
@devcode-srish is attempting to deploy a commit to the komalsony234-1530's projects Team on Vercel. A member of the Team first needs to authorize it. |
|
please use the pull request template uploaded in the repository to breifly describe the changes made |
komalharshita
left a comment
There was a problem hiding this comment.
Thank you for the contribution.
The added comments and explanations improve the readability of the recommendation logic and make the code easier for new contributors to understand, which aligns well with the goal of the issue.
However, the PR currently does not pass all required checks (25/27 tests passing). Before this can be merged, please sync with the latest main branch and resolve the failing CI checks so that all tests pass successfully.
Once the checks are green, this PR should be ready for merge.
Summary [required]
This PR improves the clarity and maintainability of the recommendation scoring system by adding beginner-friendly inline comments and explanations throughout the recommender logic.
The update explains how scoring weights are applied, how filtering works, and how recommendations are ranked, making the recommendation engine easier for new contributors to understand and extend.
Additionally, this PR fixes failing starter code endpoint tests by adding the missing starter_code/ directory and required starter file referenced in data/projects.json. This restores the /project//code and /project//download functionality and ensures the full test suite passes successfully.
Related Issue [required]
Closes #24
Type of Change [required]
data/projects.jsonWhat Was Changed [required]
utils/recommender.pyutils/file_server.pystarter_code/expense_tracker.pyHow to Test This PR [required]
git checkout your-branch-namepip install -r requirements.txtpython app.py/project/1/code
/project/1/download
python tests/test_basic.pyExpected test output:
Test Results [required]
Self-Review Checklist [required]
feat/,fix/,docs/,data/,style/,test/python tests/test_basic.pyand all 27 tests passflake8 .locally and there are no errorsprint()orconsole.log()debug statementsNotes for Reviewer
While investigating the failing CI checks, I found that the repository was missing the starter_code/ directory and referenced starter file used by the code-view and download endpoints. I added the required starter file and verified the full test suite locally.
All tests now pass successfully.