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] update readme #152

Merged
merged 1 commit into from
Aug 31, 2024
Merged

[MRG] update readme #152

merged 1 commit into from
Aug 31, 2024

Conversation

HuaizhengZhang
Copy link
Contributor

@HuaizhengZhang HuaizhengZhang commented Aug 31, 2024

User description

1 milestone
1 just keep discord

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

  • Updated the milestone dates in the README to a consistent format and added a new milestone for "Kaia is born" on 07/03/2024.
  • Simplified the contribution instructions by rephrasing the call to action.
  • Clarified the license reference by specifying "MIT License" instead of a generic "LICENSE".

Changes walkthrough 📝

Relevant files
Documentation
README.md
Update milestones and improve contribution and license sections

README.md

  • Updated milestone dates to a consistent format.
  • Added a new milestone for "Kaia is born" on 07/03/2024.
  • Simplified contribution instructions.
  • Clarified the license reference to "MIT License".
  • +7/-7     

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

    1 milestone
    1 just keep discord
    @HuaizhengZhang HuaizhengZhang self-assigned this Aug 31, 2024
    @dosubot dosubot bot added size:S This PR changes 10-29 lines, ignoring generated files. documentation Improvements or additions to documentation labels Aug 31, 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 31, 2024

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    @dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Aug 31, 2024
    @HuaizhengZhang HuaizhengZhang merged commit 579f2d9 into main Aug 31, 2024
    4 checks passed
    @HuaizhengZhang HuaizhengZhang deleted the HuaizhengZhang-patch-1 branch August 31, 2024 18:17
    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:S This PR changes 10-29 lines, ignoring generated files.
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants