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

🐛Bug Fix: Project structure text file #808

Merged
merged 8 commits into from
Oct 23, 2024
Merged

🐛Bug Fix: Project structure text file #808

merged 8 commits into from
Oct 23, 2024

Conversation

yashksaini-coder
Copy link
Contributor

Pull Request for PyVerse 💡

Requesting to submit a pull request to the PyVerse repository.


Issue Title

Please enter the title of the issue related to your pull request.
#805

  • I have provided the issue title.

Info about the Related Issue

What's the goal of the project?
PyVerse is an open-source collection of diverse Python projects, tools, and scripts, ranging from beginner to advanced, across various domains like machine learning, web development, and automation.

  • I have described the aim of the project.

Name

Please mention your name.
Yash K. Saini

  • I have provided my name.

GitHub ID

Please mention your GitHub ID.
yashksaini-coder

  • I have provided my GitHub ID.

Email ID

Please mention your email ID for further communication.
Mail

  • I have provided my email ID.

Identify Yourself

Mention in which program you are contributing (e.g., WoB, GSSOC, SSOC, SWOC).
GSSoC

  • I have mentioned my participant role.

Closes

Enter the issue number that will be closed through this PR.
*Closes: #805 *

  • I have provided the issue number.

Describe the Add-ons or Changes You've Made

Give a clear description of what you have added or modified.

This pull request includes significant updates to the directory structure script and its associated GitHub workflow. The changes simplify the script, improve its functionality, and streamline the workflow for updating the project structure.

Updates to the Directory Structure Script:

  • .github/scripts/update_dir_structure.py: Replaced the old script with a new version that generates a Markdown-formatted directory structure for Python and Jupyter files, excluding certain directories like scripts and venv. The new script uses argparse for argument parsing and includes detailed docstrings for better readability.

Updates to the GitHub Workflow:

  • .github/workflows/update-structure.yml: Modified the workflow to run on every push instead of a scheduled cron job. Simplified the job steps by removing unnecessary setup and updating the script execution to generate Project-Structure.md directly.
  • I have described my changes.

Type of Change

Select the type of change:

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Code style update (formatting, local variables)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Describe how your changes have been tested.
Describe your testing process here.

Pyverse-805.webm
  • I have described my testing process.

Checklist

Please confirm the following:

  • My code follows the guidelines of this project.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly wherever it was hard to understand.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • I have added things that prove my fix is effective or that my feature works.
  • Any dependent changes have been merged and published in downstream modules.

Copy link

👋 Thank you for opening this pull request! We're excited to review your contribution. Please give us a moment, and we'll get back to you shortly!

Feel free to join our community on Discord to discuss more!

@yashksaini-coder
Copy link
Contributor Author

@UTSAVS26 can you review this PR, and add proper labels to it

@UTSAVS26 UTSAVS26 added Contributor Denotes issues or PRs submitted by contributors to acknowledge their participation. Status: Approved ✔️ PRs that have passed review and are approved for merging. level2 gssoc-ext hacktoberfest hacktoberfest-accepted labels Oct 23, 2024
@UTSAVS26 UTSAVS26 merged commit f7cc028 into UTSAVS26:main Oct 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Contributor Denotes issues or PRs submitted by contributors to acknowledge their participation. gssoc-ext hacktoberfest hacktoberfest-accepted level2 Status: Approved ✔️ PRs that have passed review and are approved for merging.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

🐛: Project structure text file
2 participants