Skip to content

Revise README for clarity and structure#193

Closed
Dippp10-ally wants to merge 1 commit into
komalharshita:mainfrom
Dippp10-ally:patch-2
Closed

Revise README for clarity and structure#193
Dippp10-ally wants to merge 1 commit into
komalharshita:mainfrom
Dippp10-ally:patch-2

Conversation

@Dippp10-ally
Copy link
Copy Markdown

@Dippp10-ally Dippp10-ally commented May 16, 2026

Updated README to enhance project description and formatting.

Summary [required]

Related Issue [required]

Closes #105

Type of Change [required]

  • Bug fix — resolves a broken behaviour
  • Feature — adds new functionality
  • Data — adds new projects to data/projects.json
  • Documentation — updates docs, README, or code comments only
  • Style — CSS or visual changes only, no logic change
  • Refactor — restructures code without changing behaviour
  • Test — adds or updates tests

What Was Changed [required]

File Change made
utils/recommender.py Added clear_cache() function
tests/test_basic.py Added test for cache invalidation

How to Test This PR [required]

  1. Clone this branch: git checkout your-branch-name
  2. Install dependencies: pip install -r requirements.txt
  3. Run the app: python app.py
  4. Open http://127.0.0.1:5000 and...
  5. Run the tests: python tests/test_basic.py

Expected test output:

27 passed, 0 failed out of 27 tests

Test Results [required]

paste output here

Screenshots (if UI change)

Before After
screenshot screenshot

Self-Review Checklist [required]

  • I have read CONTRIBUTING.md and followed all guidelines
  • My branch name follows the convention: feat/, fix/, docs/, data/, style/, test/
  • I have run python tests/test_basic.py and all 27 tests pass
  • I have run flake8 . locally and there are no errors
  • I have not introduced any print() or console.log() debug statements
  • Every new function I wrote has a docstring
  • I have not modified files outside the scope of the linked issue
  • If I changed the UI, I tested it at 375px (mobile) and 1280px (desktop)
  • If I added a project to the dataset, it has all required JSON fields

Notes for Reviewer

Updated README to enhance project description and formatting.
@vercel
Copy link
Copy Markdown

vercel Bot commented May 16, 2026

@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.

@Dippp10-ally
Copy link
Copy Markdown
Author

Dippp10-ally commented May 16, 2026

@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

@komalharshita
Copy link
Copy Markdown
Owner

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!

@komalharshita komalharshita added gssoc:invalid This doesn't seem right gssoc-2026 labels May 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Implement advanced README rendering and documentation system improvements

2 participants