Revise README for clarity and structure#193
Conversation
Updated README to enhance project description and formatting.
|
@Dippp10-ally 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. |
|
@komalharshita ji , l have closed pull request number 164 and created pull request number 193 to incorporate changes you requested......do assign gssoc:approved and level:intermediate labels to issue number 105 and pull request number 193 |
|
Thank you for the effort put into improving the README structure and formatting. After a detailed review, I’ve decided not to merge this PR because, although the formatting became cleaner, the updated version removes several important project-specific documentation sections and contributor guidance that are valuable for onboarding and GSSoC participation. The PR improves readability in some areas, but overall it reduces the depth and usefulness of the existing README content. I appreciate the contribution and encourage you to explore other open issues that involve more focused improvements without removing existing documentation coverage. Closing this PR for now. Thanks again for contributing to DevPath! |
Updated README to enhance project description and formatting.
Summary [required]
Related Issue [required]
Closes #105
Type of Change [required]
data/projects.jsonWhat Was Changed [required]
utils/recommender.pyclear_cache()functiontests/test_basic.pyHow to Test This PR [required]
git checkout your-branch-namepip install -r requirements.txtpython app.pypython tests/test_basic.pyExpected test output:
Test Results [required]
Screenshots (if UI change)
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