You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
@PriyaGhosal I raised this issue to fix the issue #162. I raised this PR to fix the merge conflicts that came in my previous PR #203. It fixes the action workflows & add the original README code. Also add few extra iconic widgets in the Footer in the Contributors section of the README.
It introduces several updates that automate the repository maintenance and enhance the README.md file. The key changes include adding scripts and workflows for updating the repository structure and contributors list, and improving the README.md layout.
Automation Scripts and Workflows:
Added script to update repository structure: The new script update_structure.py generates and updates the repository structure in project-structure.md and project_structure.txt files. (.github/scripts/update_structure.py)
Workflow to update repository structure: A new GitHub Actions workflow runs the update_structure.py script every hour and on pushes to the main branch. (.github/workflows/update-structure.yml)
Workflow to update contributors list: Added a GitHub Actions workflow to automatically update the contributors list in the README.md file on pushes to the main branch. (.github/workflows/add-contributor.yml)
README Enhancements:
Enhanced layout and added badges: Improved the README.md file layout by adding a centered header, badges, and contributors section. (README.md) [1][2][3]
Added project structure section: Included a new section in README.md to link to the project-structure.md file, which details the project structure. (project-structure.md)
Type of PR
Bug fix
Feature enhancement
Documentation update
Other (specify): _______________
Screenshots / videos (if applicable)
Buddy_trail-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.
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! 😊
@yashksaini-coder Your pull request has been successfully merged! Don't stop here—continue contributing by addressing more issues and aiming to become a top contributor. Exclusive swag awaits for those who go the extra mile!
Great contribution to GSSOC'24 EXTENDED! 🎉
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Related Issue
Fixes: #162
Description
@PriyaGhosal I raised this issue to fix the issue #162. I raised this PR to fix the merge conflicts that came in my previous PR #203. It fixes the action workflows & add the original README code. Also add few extra iconic widgets in the Footer in the Contributors section of the README.
It introduces several updates that automate the repository maintenance and enhance the
README.mdfile. The key changes include adding scripts and workflows for updating the repository structure and contributors list, and improving theREADME.mdlayout.Automation Scripts and Workflows:
update_structure.pygenerates and updates the repository structure inproject-structure.mdandproject_structure.txtfiles. (.github/scripts/update_structure.py)update_structure.pyscript every hour and on pushes to themainbranch. (.github/workflows/update-structure.yml)README.mdfile on pushes to themainbranch. (.github/workflows/add-contributor.yml)README Enhancements:
README.mdfile layout by adding a centered header, badges, and contributors section. (README.md) [1] [2] [3]README.mdto link to theproject-structure.mdfile, which details the project structure. (project-structure.md)Type of PR
Screenshots / videos (if applicable)
Buddy_trail-162.webm
Checklist: