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

Update README.md for v030 #119

Merged
merged 1 commit into from
Jul 26, 2024
Merged

Update README.md for v030 #119

merged 1 commit into from
Jul 26, 2024

Conversation

HuaizhengZhang
Copy link
Contributor

@HuaizhengZhang HuaizhengZhang commented Jul 26, 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 new milestone dates for v0.3.0 and v0.2.0 releases.
  • Included instructions for installing the package from source.
  • Removed the example user requirements section to streamline the README.

Changes walkthrough 📝

Relevant files
Documentation
README.md
Update README with milestones and installation instructions

README.md

  • Added new milestone dates for v0.3.0 and v0.2.0 releases.
  • Added instructions for installing from source.
  • Removed example user requirements section.
  • +7/-23   

    💡 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 Jul 26, 2024
    @dosubot dosubot bot added size:M This PR changes 30-99 lines, ignoring generated files. documentation Improvements or additions to documentation labels Jul 26, 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 Jul 26, 2024

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Enhancement
    Reorder the milestones in chronological order

    Consider reordering the milestones in chronological order to improve readability and
    logical flow.

    README.md [32-34]

     ## Milestones
     
    +- :rocket: June 1st, 2024: Release the first rule-based version of MLE agent (v0.1.0)
    +- :rocket: 11 July 2024: Release the `0.2.0` with multiple agents interaction (v0.2.0)
     - :rocket: 25 July 2024: Release the `0.3.0` with huge refactoring, many integrations, etc (v0.3.0)
    -- :rocket: 11 July 2024: Release the `0.2.0` with multiple agents interaction (v0.2.0)
    -- :rocket: June 1st, 2024: Release the first rule-based version of MLE agent (v0.1.0)
     
    Suggestion importance[1-10]: 8

    Why: Reordering the milestones in chronological order improves readability and logical flow, making it easier for users to follow the project's timeline.

    8
    Provide context for the installation method from source

    Add a brief description or context for the installation from source to help users
    understand why they might prefer this method.

    README.md [42-44]

    -# or from source
    +# or from source for the latest development version
     git clone git@github.com:MLSysOps/MLE-agent.git
     pip install -e .
     
    Suggestion importance[1-10]: 7

    Why: Adding a brief description for the installation from source helps users understand the purpose and benefits of this method, improving the documentation's clarity.

    7

    @dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Jul 26, 2024
    @huangyz0918 huangyz0918 merged commit 26117af into main Jul 26, 2024
    4 checks passed
    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:M This PR changes 30-99 lines, ignoring generated files.
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants