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 README.md #2

Merged
merged 2 commits into from
Jan 14, 2025
Merged

doc: update README.md #2

merged 2 commits into from
Jan 14, 2025

Conversation

Tohrusky
Copy link
Member

@Tohrusky Tohrusky commented Jan 14, 2025

Summary by Sourcery

Update the project's README file with badges, installation instructions, requirements, and license information. Bump version to 0.0.2.

Enhancements:

  • Add installation instructions and project requirements to the README.
  • Add license information and link to the LICENSE file in the README.

Documentation:

  • Add badges for CI, releases, PyPI version, and license to the README.

Copy link

sourcery-ai bot commented Jan 14, 2025

Reviewer's Guide by Sourcery

This pull request updates the project's README file with badges, requirements, installation instructions, and license information. It also updates the project version in pyproject.toml.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added badges, requirements, installation instructions, and license information to the README
  • Added various badges for CI, releases, PyPI version, and license.
  • Included requirements for mvsfunc and havsfunc.
  • Added installation instructions using pip.
  • Added license information with a link to the LICENSE file.
README.md
Updated project version
  • Updated version from 0.0.1 to 0.0.2 in pyproject.toml
pyproject.toml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @Tohrusky - I've reviewed your changes - here's some feedback:

Overall Comments:

  • The CI and Release badge URLs point to 'yuisub' instead of 'mbfunc'. Please update these URLs to point to the correct repository.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

README.md Outdated Show resolved Hide resolved
@Tohrusky
Copy link
Member Author

@sourcery-ai review

@Tohrusky Tohrusky merged commit 46b1c1b into TensoRaws:main Jan 14, 2025
2 checks passed
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