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

[MRG] add star history #125

Merged
merged 1 commit into from
Aug 12, 2024
Merged

[MRG] add star history #125

merged 1 commit into from
Aug 12, 2024

Conversation

HuaizhengZhang
Copy link
Contributor

@HuaizhengZhang HuaizhengZhang commented Aug 12, 2024

User description

Closes #

What has been done to verify that this works as intended?

Why is this the best possible solution? Were any other approaches considered?

How does this change affect users? Describe intentional changes to behavior and behavior that could have accidentally been affected by code changes. In other words, what are the regression risks?

Do we need any specific form for testing your changes? If so, please attach one.

Does this change require updates to documentation? If so, please file an issue here and include the link below.

Before submitting this PR, please make sure you have:

  • confirmed all checks still pass OR confirm CI build passes.
  • verified that any code or assets from external sources are properly credited in comments and/or in
    the credit file.

PR Type

documentation


Description

  • Added a new "Star History" section to the README.md file.
  • Included a Star History Chart that links to star-history.com for visualizing the repository's star history.

Changes walkthrough 📝

Relevant files
Documentation
README.md
Add Star History section with chart                                           

README.md

  • Added a new section for Star History.
  • Included a Star History Chart with a link to star-history.com.
  • +3/-0     

    💡 PR-Agent usage:
    Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    @HuaizhengZhang HuaizhengZhang self-assigned this Aug 12, 2024
    @dosubot dosubot bot added size:XS This PR changes 0-9 lines, ignoring generated files. enhancement New feature or request labels Aug 12, 2024
    @github-actions github-actions bot added documentation Improvements or additions to documentation Review effort [1-5]: 1 and removed enhancement New feature or request labels Aug 12, 2024
    Copy link

    PR Reviewer Guide 🔍

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ No key issues to review

    Copy link

    github-actions bot commented Aug 12, 2024

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Enhancement
    Add a description to the "Star History Chart" to provide context and enhance reader engagement

    Consider adding a brief description or caption for the "Star History Chart" to
    provide context to the readers about what the chart represents and why it might be
    interesting or useful to them.

    README.md [142]

    +## Star History
    +The Star History chart below shows the stargazing trend of our project over time. This can give you an insight into the growing interest and community engagement with our project.
     [![Star History Chart](https://api.star-history.com/svg?repos=MLSysOps/MLE-agent&type=Date)](https://star-history.com/#MLSysOps/MLE-agent&Date)
     
    Suggestion importance[1-10]: 9

    Why: The suggestion adds valuable context to the "Star History Chart," making it more informative and engaging for readers. This enhances the readability and usefulness of the README file.

    9

    @dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Aug 12, 2024
    @huangyz0918 huangyz0918 merged commit ac80ab7 into main Aug 12, 2024
    4 checks passed
    @huangyz0918 huangyz0918 deleted the hz/star branch August 12, 2024 20:31
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    documentation Improvements or additions to documentation lgtm This PR has been approved by a maintainer Review effort [1-5]: 1 size:XS This PR changes 0-9 lines, ignoring generated files.
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants