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

Some minor changes on documentation #5

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

1Shubham7
Copy link

@1Shubham7 1Shubham7 commented Oct 3, 2024

Pull Request Template

Description

I was just going though the repo and saw that the readme had some issues, looks like it was AI generated and some wrong stuff was copy pasted so I just fixed that : )

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • 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?

NA

Additional Context (Please include any Screenshots/gifs if relevant)

...

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have checked my code and corrected any misspellings
  • I have tagged the reviewers in a comment below incase my pull request is ready for a review
  • I have signed the commit message to agree to Developer Certificate of Origin (DCO) (to certify that you wrote or otherwise have the right to submit your contribution to the project.) by adding "--signoff" to my git commit command.

Signed-off-by: Shubham Singh <shubhammahar1306@gmail.com>
@1Shubham7 1Shubham7 changed the title Minor changes on readme Some minor changes on documentation Oct 3, 2024
@Sonichigo Sonichigo self-requested a review October 14, 2024 08:00
@1Shubham7
Copy link
Author

PTAL @Sonichigo : )

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

Successfully merging this pull request may close these issues.

1 participant