Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Automation of project structure updation using GitHub workflows and Python scripts #73

Merged
merged 7 commits into from
Oct 31, 2024

Conversation

rajdeepchakraborty-rc
Copy link
Contributor

Issue Resolved:

Description

The project did not have a project structure, which would make it difficult for the newcomers to understand the project structure better.
I have added a detailed project structure(redirect in README.md) in a separate file(since the project structure is very long and would make the README file too long making it less readable to the users) for the contributors to refer to and also automated its updation process as new files are added in the projects.

NOTE: Every time any changes are pushed into the master branch, the workflow will run and then update the structure(if any changes).

This will help the contributors refer to the structure and will make it easier for them to understand where to contribute.
Also, it's difficult for anyone to manually change the project structure as it grows in size day by day. So, automating this with GitHub workflows and Python script will make the maintenance easier and help you focus on reviewing PR and assigning issues.

Screenshots

  • Redirect:
    image

  • Project structure:
    image
    image

Copy link

vercel bot commented Oct 31, 2024

@rajdeepchakraborty-rc is attempting to deploy a commit to the vansh-codes1's projects Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

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! 😊

@rajdeepchakraborty-rc
Copy link
Contributor Author

rajdeepchakraborty-rc commented Oct 31, 2024

@vansh-codes Please review the PR at your convenience. I would appreciate a level3/level2 label(as you deem appropriate) if possible, since I have implemented and automated the update process.

Copy link
Owner

@vansh-codes vansh-codes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good job!

@vansh-codes vansh-codes added documentation Improvements or additions to documentation enhancement New feature or request gssoc-ext GSSOC'24 Extd Participant level1 awards 10 points hacktoberfest-accepted hacktoberfest accepted labels Oct 31, 2024
@vansh-codes
Copy link
Owner

Brother documentation and workflows are supposed to be level1, because you worked hard on it and created on your own, I have you level3 for the previous PR, for this repo you would have copy pasted the code with minor changes, so I guess level1 is good for this

@vansh-codes vansh-codes merged commit b764aec into vansh-codes:master Oct 31, 2024
1 of 2 checks passed
@rajdeepchakraborty-rc
Copy link
Contributor Author

Brother documentation and workflows are supposed to be level1, because you worked hard on it and created on your own, I have you level3 for the previous PR, for this repo you would have copy pasted the code with minor changes, so I guess level1 is good for this

Sure. Thanks for reviewing the PR! Hope you have a great day ahead!

@vansh-codes
Copy link
Owner

Hii @rajdeepchakraborty-rc

I encountered this error for the workflow

Screenshot 2024-11-06 222728

Can you please look into this issue and fix it?
Do create a new issue, i will assign it to you with level1

@rajdeepchakraborty-rc
Copy link
Contributor Author

rajdeepchakraborty-rc commented Nov 6, 2024

@vansh-codes Sure I will look into it.

Opened Issue #83

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request gssoc-ext GSSOC'24 Extd Participant hacktoberfest-accepted hacktoberfest accepted level1 awards 10 points
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Doc Update: Automation of project structure updation using GitHub workflows and Python scripts
2 participants