-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Update README.md with migration news #659
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @DavdGao, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request updates the README.md to clearly communicate the project's upcoming major version migration strategy. It aims to provide transparency to users about the transition from v0 to v1, outlining branch changes and support plans, ensuring they are well-informed about future development and maintenance.
Highlights
- Version Migration Announcement: I've added a prominent notice to the
README.mdto inform users about the upcoming major version migration of AgentScope to v1. - Branching Strategy Clarification: The update details the plan for managing branches during the migration, specifically that the current
mainbranch will becomev0, and a newmainbranch will be created for v1 code. - Guidance for v0 Users: The
README.mdnow includes a note for current v0 users, assuring them of continued bug fixes and PyPI updates for v0, while strongly recommending migration to v1 for new features and enhancements.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments or fill out our survey to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request updates the README.md to inform users about the upcoming v1 migration and the plan for supporting both v0 and v1. The changes are clear and informative. I've suggested a minor formatting improvement to consistently highlight version numbers as code, which will enhance readability.
| > AgentScope is currently preparing to migrate to v1. As this is a major update, we will make the following adjustments to maintain both v0 and v1 versions: | ||
| > | ||
| > 1. The current `main` branch will be copied to a new `v0` branch | ||
| > 2. A new `main` branch will be created with v1 code, which will become the default branch of this repository | ||
| > | ||
| > > **Note for v0 Users** | ||
| > > | ||
| > > The v0 version will enter maintenance mode after the migration. We will: | ||
| > > - Continue to fix bugs in the v0 version | ||
| > > - Release updates to PyPI with v0.x.x version numbers | ||
| > > | ||
| > > Therefore, users currently using v0 can continue to use it without concerns. We are committed to maintaining the stability of the v0 version. | ||
| > > | ||
| > > However, we strongly recommend users to migrate to v1 when it becomes available to benefit from new features and improvements. The v1 version will bring significant enhancements to your development experience. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For better readability and consistency, it's a good practice to wrap version numbers in backticks ( ) to format them as code. This helps them stand out from the surrounding text. You've already done this for branch names like `main`, but it's inconsistent for version numbers.
| > AgentScope is currently preparing to migrate to v1. As this is a major update, we will make the following adjustments to maintain both v0 and v1 versions: | |
| > | |
| > 1. The current `main` branch will be copied to a new `v0` branch | |
| > 2. A new `main` branch will be created with v1 code, which will become the default branch of this repository | |
| > | |
| > > **Note for v0 Users** | |
| > > | |
| > > The v0 version will enter maintenance mode after the migration. We will: | |
| > > - Continue to fix bugs in the v0 version | |
| > > - Release updates to PyPI with v0.x.x version numbers | |
| > > | |
| > > Therefore, users currently using v0 can continue to use it without concerns. We are committed to maintaining the stability of the v0 version. | |
| > > | |
| > > However, we strongly recommend users to migrate to v1 when it becomes available to benefit from new features and improvements. The v1 version will bring significant enhancements to your development experience. | |
| > AgentScope is currently preparing to migrate to `v1`. As this is a major update, we will make the following adjustments to maintain both `v0` and `v1` versions: | |
| > | |
| > 1. The current `main` branch will be copied to a new `v0` branch | |
| > 2. A new `main` branch will be created with `v1` code, which will become the default branch of this repository | |
| > | |
| > > **Note for v0 Users** | |
| > > | |
| > > The `v0` version will enter maintenance mode after the migration. We will: | |
| > > - Continue to fix bugs in the `v0` version | |
| > > - Release updates to PyPI with `v0.x.x` version numbers | |
| > > | |
| > > Therefore, users currently using `v0` can continue to use it without concerns. We are committed to maintaining the stability of the `v0` version. | |
| > > | |
| > > However, we strongly recommend users to migrate to `v1` when it becomes available to benefit from new features and improvements. The `v1` version will bring significant enhancements to your development experience. |
Description
[Please describe the background, purpose, changes made, and how to test this PR]
Checklist
Please check the following items before code is ready to be reviewed.