Skip to content

Comments

Improve README with screenshots and project structure#433

Open
srushtiipatel wants to merge 1 commit intoangelabera:mainfrom
srushtiipatel:main
Open

Improve README with screenshots and project structure#433
srushtiipatel wants to merge 1 commit intoangelabera:mainfrom
srushtiipatel:main

Conversation

@srushtiipatel
Copy link

Pull Request

Summary

Improved the README by adding project structure details and screenshots to make the project easier to understand for new contributors.

  • Added project structure diagram
  • Updated README screenshots for better understanding about the project

Type of Change

  • ✨ New feature
  • 🐛 Bug fix
  • 🎨 UI / UX improvement
  • ♻️ Refactor / cleanup
  • ⚡ Performance improvement
  • 📱 Responsive / mobile fix
  • [ X] 📚 Documentation update
  • 🧪 Tests (if applicable)

Related Issue(s)

N/A


What Was Changed

  • Enhanced README clarity

  • Added visual references for project structure


Screenshots / Demo (Required for UI changes)

Screenshots are included in the updated README.


How to Test

  1. Open README.md
  2. Verify screenshots and project structure section are clear and readable

@akbatra567
Copy link
Collaborator

Is there any issue that this PR resolves ? @srushtiipatel

@srushtiipatel
Copy link
Author

Hi @akbatra567,
This PR does not resolve a specific issue. It improves project documentation by adding screenshots and clarifying the project structure to help new contributors understand the repo better. Thanks!

@akbatra567
Copy link
Collaborator

Can you raise an issue for the PR to describe the value addition?

Also in future do follow the process of first raising issue and after being assigned the issue raise the PR for the fix.

So that you don't over work for the things that are not planned and project admin and mentor and can streamline the project deliverables.

cc: @srushtiipatel

@srushtiipatel
Copy link
Author

Thanks for the guidance.

I’ve raised an issue describing the value addition of this PR and linked it here.
I’ll make sure to raise an issue first and wait for assignment before
submitting PRs in the future.

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