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

Doc Update: Automation of project structure updation using GitHub workflows and Python scripts #71

Closed
4 tasks done
rajdeepchakraborty-rc opened this issue Oct 30, 2024 · 1 comment · Fixed by #73
Closed
4 tasks done
Assignees
Labels
documentation Improvements or additions to documentation gssoc-ext GSSOC'24 Extd Participant hacktoberfest-accepted hacktoberfest accepted level1 awards 10 points

Comments

@rajdeepchakraborty-rc
Copy link
Contributor

Describe the Documentation Update

Describe your chaotic idea

Currently, the project doesn't have a project structure. And, it would be a bit difficult for newcomers to understand the project and how to add more chaos to it's existing 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 maintenance easier and enhance organised chaos(metaphor!).

I want to add a detailed project structure in a separate file(redirect in README.md) for the contributors to refer to and automate its updation process 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 the structure and spread more chaos to the project. 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 a Python script will make the project more accessible to the Contributors and spread more chaos.

Add Screenshots (if applicable)

Add Screenshots or Sketches

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

image

Confirm

  • I agree to follow this project's Code of Conduct
  • I'm GSSOC'24 Extd registered Contributor
  • I'm Hacktoberfest registered Contributor
  • I want to work on this documentation issue
Copy link
Contributor

Hello @rajdeepchakraborty-rc! Your issue #71 has been successfully closed. ✅ Thank you for your contribution and helping us improve the project! If you have any more ideas or run into other issues, feel free to open a new one. Happy coding! 🚀

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 gssoc-ext GSSOC'24 Extd Participant hacktoberfest-accepted hacktoberfest accepted level1 awards 10 points
Projects
None yet
2 participants