refactor: Move payment schemes out of versioned directory #30
Conversation
Summary of ChangesHello @lingzhong, 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 refactors the project's directory structure by relocating payment scheme definition files. The primary goal is to enhance maintainability and organization by ensuring that these schemes are not tied to a specific protocol version. This strategic move prevents future overhead associated with version upgrades and centralizes scheme definitions in a more logical, version-independent location. Highlights
Using Gemini Code AssistThe 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 by creating a comment using either
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 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. 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
|
There was a problem hiding this comment.
Code Review
This pull request correctly moves the payment scheme documents from v0.1/schemes/ to a root-level schemes/ directory. This is a valuable refactoring that decouples the schemes from a specific protocol version, which improves long-term maintainability. However, the change is incomplete because the main README.md file, which outlines the repository structure, has not been updated to reflect this move. It still shows the schemes directory under v0.1/. To ensure the documentation is accurate and prevent confusion for other contributors, I recommend updating the README.md file as part of this pull request.
|
FYI: How to handle scheme versioning in the future is a out of scope for this PR. |
jorellis
left a comment
There was a problem hiding this comment.
Thanks Ling! Can you also update the "repository structure" section in the base README file?
Good catch. Done. |
|
Hey @jorellis , re-approval required now that I touched a new file. Thanks! |
Summary
Move payment schemes from
v0.1/schemes/toschemes/to avoid version couplingRationale
Schemes should be version-independent to avoid requiring moves/updates every time a new protocol version is released. This provides better maintainability and cleaner organization.
Changes
v0.1/schemes/to root-levelschemes/v0.1/schemes/directory