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 #1048

Closed
3 tasks done
rajdeepchakraborty-rc opened this issue Oct 27, 2024 · 2 comments
Closed
3 tasks done

Comments

@rajdeepchakraborty-rc
Copy link

Is your feature request related to a problem? Please describe.

Currently, the project doesn't have a project structure. And, it would be a bit difficult for new commers to understand the project structure completely. 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 maintainance easier.

Describe the solution you'd like.

I want to add a detailed project structure in a separate file(redirect in README.md) for the contributors to refer to and automate the process of it's updation as new files are added in the projects. This will help them refer to the structure and will make it easier for them to understand.

Describe alternatives you've considered.

I would like to have your feedback on whether the feature is working for you after the merge. I have tested it out by creating a sample repository. But conducting another test won't harm, which will increase the credibility of this feature. Hope I can get your cooperation.

Additional context.

None.

Show us the magic with screenshots

Sample of how the workflow would be automated and the project structure after updation in readme:
image

image

Checklist

Copy link

Hi there! Thanks for opening this issue. We appreciate your contribution to this open-source project. We aim to respond or assign your issue as soon as possible.

@rajdeepchakraborty-rc
Copy link
Author

Kindly assign this issue @aditya-bhaumik , @Apoorva57

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

No branches or pull requests

2 participants