Skip to content
This repository has been archived by the owner on Dec 24, 2024. It is now read-only.

Update README.md #126

Merged
merged 1 commit into from
Dec 24, 2024
Merged

Update README.md #126

merged 1 commit into from
Dec 24, 2024

Conversation

xtsea
Copy link
Contributor

@xtsea xtsea commented Dec 24, 2024

Summary by Sourcery

Documentation:

  • Add a note to the README stating that the project is no longer maintained.

Copy link
Contributor

sourcery-ai bot commented Dec 24, 2024

Reviewer's Guide by Sourcery

This pull request updates the README.md file to indicate that the project is no longer maintained. It also provides a link to a suggested alternative library.

State diagram showing project maintenance status change

stateDiagram-v2
    [*] --> Maintained
    Maintained --> NoLongerMaintained: Project status update
    NoLongerMaintained --> [*]

    note right of NoLongerMaintained
        Users directed to akenoai-lib
        as alternative
    end note
Loading

File-Level Changes

Change Details Files
Added a note to the README file indicating that the project is no longer maintained and suggesting an alternative library.
  • Added a note section with a message indicating project status.
  • Included a link to the suggested alternative library 'akenoai-lib'.
README.md

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

@xtsea xtsea merged commit b53b358 into TeamKillerX:dev Dec 24, 2024
4 checks passed
Copy link
Contributor

@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 @xtsea - I've reviewed your changes - here's some feedback:

Overall Comments:

  • The added '### Note' heading is redundant since the '[!NOTE]' block syntax already provides appropriate formatting and heading functionality. Please remove the added heading to maintain cleaner documentation.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 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.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant