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

Updated README.md #22

Closed
wants to merge 1 commit into from
Closed

Updated README.md #22

wants to merge 1 commit into from

Conversation

ashmittt08
Copy link

Issue Title :

  • Info about the related issue (Aim of the project) :
  • Name:
  • GitHub ID:
  • Email ID:
  • Identify yourself: (Mention in which program you are contributing. Eg. For a WoB 2024 participant, it's WoB Participant)

Closes: #issue_number that will be closed through this PR


Snippet Details 📃

  • Snippet Name: <snippet_name>
  • Category: (e.g., strings, numbers, files)
  • Function Name: <function_name>

Summary of Changes

  1. Added badges for version, build status, license, contributors, and issues to the top of the README.
  2. Improved the "Table of Contents" by adding sub-sections and linking to specific sections.
  3. Added a new "Quick Start" section for users to immediately see how to use the package.
    4)Updated the "Features" section with emojis for better readability and added clarity for each feature.
    5)Added a "Why Use PySnippets?" section to highlight the benefits of the package.
    6)Created a "Roadmap" section to outline upcoming features and future development plans.
  4. Maintained clear code examples and explanations throughout the document.

Code Changes

  • Documentation update

Example Usage

python

PySnippets - A Python Package for Reusable Code Snippets

PyPI Version
Build Status
License
Contributors
Issues


Type of Change ☑️

What sort of change have you made:

  • 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? ⚙️

  1. Verified that all markdown links in the "Table of Contents" lead to the correct sections.
  2. Checked that badges load correctly and display accurate information.
  3. Reviewed the content for clarity and ensured it improves user navigation and understanding.

Checklist ☑️

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

Copy link
Contributor

github-actions bot commented Oct 5, 2024

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

@github-actions github-actions bot requested a review from UTSAVS26 October 5, 2024 13:49
@UTSAVS26
Copy link
Owner

UTSAVS26 commented Oct 5, 2024

@ashmittt08 who told you to work on this issue? I am not merging it, as said I have assigned it to some other contributor check once before raising PR #8.

@UTSAVS26 UTSAVS26 added invalid This doesn't seem right wontfix This will not be worked on spam Used to mark invalid or spammy PRs or issues labels Oct 5, 2024
@UTSAVS26 UTSAVS26 closed this Oct 5, 2024
@ashmittt08
Copy link
Author

it is showing no assignees

@UTSAVS26
Copy link
Owner

UTSAVS26 commented Oct 5, 2024

Check it again I have assigned the issue to Yash.

@UTSAVS26
Copy link
Owner

UTSAVS26 commented Oct 5, 2024

you have cleary assigned me this above

I don't assign it to you but approve the changes the changes you made.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
invalid This doesn't seem right spam Used to mark invalid or spammy PRs or issues wontfix This will not be worked on
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants