-
Notifications
You must be signed in to change notification settings - Fork 52
docs: add CIP-Matcha Network Upgrade #338
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 @evan-forbes, 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 introduces a new meta-CIP (CIP-041) that formally defines the 'Matcha Network Upgrade'. This CIP serves as a central reference point, consolidating and listing all the individual state-breaking CIPs that are part of this significant network upgrade. Its purpose is to provide a clear, comprehensive overview of the changes encompassed by the Matcha upgrade.
Highlights
- New Meta-CIP (CIP-041): I've added a new document, CIP-041, which serves as a meta-CIP specifically for the upcoming 'Matcha Network Upgrade'. This CIP acts as a central reference point for all changes included in this upgrade.
- Matcha Network Upgrade Scope: This meta-CIP explicitly lists and references five individual state-breaking CIPs (CIP-36, CIP-37, CIP-38, CIP-39, and CIP-40) that collectively constitute the Matcha Network Upgrade. It clarifies that all these changes necessitate a breaking network upgrade.
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 introduces CIP-041, a meta-CIP for the Matcha network upgrade. The new document is well-structured and clearly lists the constituent CIPs for the upgrade. My review focuses on ensuring the new document adheres to the repository's formatting conventions and templates. I've suggested a few minor changes to improve consistency, such as updating the author and description format, providing a more specific discussions-to link, and adding a newline at the end of the file.
cips/cip-041.md
Outdated
| | cip | 41 | | ||
| |--------------------|------------------------------------------------------------------------------------------------| | ||
| | title | Matcha Network Upgrade | | ||
| | description | Reference specifications included in the Matcha Network Upgrade | |
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.
According to the cip-template.md, the description field should contain a full, short sentence. The current description is a sentence fragment. Making this a complete sentence would improve consistency with the template.
| | description | Reference specifications included in the Matcha Network Upgrade | | |
| | description | This CIP provides reference specifications included in the Matcha Network Upgrade. | |
cips/cip-041.md
Outdated
| |--------------------|------------------------------------------------------------------------------------------------| | ||
| | title | Matcha Network Upgrade | | ||
| | description | Reference specifications included in the Matcha Network Upgrade | | ||
| | author | [@evan-forbes](https://github.com/evan-forbes) | |
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.
The format for the author field doesn't align with the convention specified in cip-template.md and seen in other recent CIPs (e.g., CIP-38, CIP-39). The template suggests the format FirstName LastName ([@GitHubUsername](...)). Including the author's full name would improve consistency.
| | author | [@evan-forbes](https://github.com/evan-forbes) | | |
| | author | Evan Forbes ([@evan-forbes](https://github.com/evan-forbes)) | |
cips/cip-041.md
Outdated
| | title | Matcha Network Upgrade | | ||
| | description | Reference specifications included in the Matcha Network Upgrade | | ||
| | author | [@evan-forbes](https://github.com/evan-forbes) | | ||
| | discussions-to | <https://forum.celestia.org> | |
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.
The discussions-to link points to the generic Celestia forum homepage. For better traceability and to centralize the conversation, this should point to a specific forum post dedicated to the Matcha network upgrade. This is a common convention in other CIPs within this repository.
| | discussions-to | <https://forum.celestia.org> | | |
| | discussions-to | <https://forum.celestia.org/t/matcha-network-upgrade/XXXX> | |
|
@evan-forbes just FYI, the convention I've noticed in the past is that CIP submitters don't assign the CIP number. That is done by the reviewers. Not that we can't change it if we feel the convention isn't necessary |
|
@evan-forbes do you want to update this and include the reduced inflation CIP? |
|
is this ready for review @evan-forbes ? |
|
just updated @jcstein note I removed the CIP number and file name as to avoid picking one prematurely per req, so that will have to be changed |
Overview
adds the meta CIP for the matcha upgrade
blocked on #337
For editors