Fix: README enhancements (Contributors list + Repository structure

[yashksaini-coder]

Related Issue

✅ Fixes: #162

Description

This pull request introduces several updates to automate the repository structure maintenance and enhance the README file. The most important changes include adding scripts to update the repository structure, creating workflows to automate these updates, and improving the README file with a new format and additional sections.

Automation of Repository Structure Updates:

• .github/scripts/update_structure.py: Added a script to generate and update the repository structure in project_structure.txt and project-structure.md.
• .github/workflows/update-structure.yml: Created a workflow to run the structure update script on a schedule and on pushes to the main branch.

README Enhancements:

• README.md: Reformatted the README with a centered title, added a statistics table, and included new sections for project structure and contributors. [1] [2] [3]

Contributor Automation:

• .github/workflows/add-contributor.yml: Added a workflow to automatically update the contributors list in the README file.

Project Structure Documentation:

• project-structure.md: Added a new file to document the project structure, which will be updated by the automation script.
• project_structure.txt: Created a text file to store the current repository structure, which is used by the automation script.

---

Type of PR

• Bug fix
• Feature enhancement
• Documentation update
• Other (specify): _______________

Screenshots / videos (if applicable)

Buddy-tail-162.webm

Checklist:

• I have made this change from my own.
• I have taken help from some online resources.
• My code follows the style guidelines of this project.
• I have performed a self-review of my own code.
• I have commented my code, particularly in hard-to-understand areas.
• I have made corresponding changes to the documentation.
• My changes generate no new warnings.
• I have tested the changes thoroughly before submitting this pull request.
• I have provided relevant issue numbers and screenshots after making the changes.

[github-actions]

Thank you for submitting your pull request! 🙌 We'll review it as soon as possible. In the meantime, please ensure that your changes align with our contributing.md. If there are any specific instructions or feedback regarding your PR, we'll provide them here. Thanks again for your contribution! 😊

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
buddy-trail	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 7, 2024 1:29pm

[netlify]

❌ Deploy Preview for preeminent-madeleine-1a49e0 failed. Why did it fail? →

Name	Link
🔨 Latest commit	6d0879e
🔍 Latest deploy log	https://app.netlify.com/sites/preeminent-madeleine-1a49e0/deploys/6703e229e4e1670008ec10f2

[netlify]

❌ Deploy Preview for scintillating-paletas-281a2f failed. Why did it fail? →

Name	Link
🔨 Latest commit	6d0879e
🔍 Latest deploy log	https://app.netlify.com/sites/scintillating-paletas-281a2f/deploys/6703e229686f19000854fac5

[yashksaini-coder]

Hi @PriyaGhosal I added new workflows that will generate contributors list and will show their display profiles with links in the Contributors section of the README.

Please review this PR & add labels Level 2, hacktoberfest hacktoberfest-accepted to this issue.

[PriyaGhosal]

@yashksaini-coder

Please see the conflicts highlighted in the image above. Resolve the conflicts in the mentioned files. Ensure you pull all the latest changes before pushing your feature/bug fixes to the main branch. After resolving the conflicts, please open a new PR for review.
Thank you!