Skip to content

Add Prerequisites section to README under How to Use#261

Open
skate29 wants to merge 1 commit into
alibaba:mainfrom
skate29:docs/add-prerequisites-git-version
Open

Add Prerequisites section to README under How to Use#261
skate29 wants to merge 1 commit into
alibaba:mainfrom
skate29:docs/add-prerequisites-git-version

Conversation

@skate29

@skate29 skate29 commented Jul 1, 2026

Copy link
Copy Markdown

Description

add new “Prerequisites” section under the existing “How to Use” heading and before the CLI subsection.

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Refactoring (no functional changes)
  • Documentation update
  • CI / Build / Tooling

How Has This Been Tested?

  • make test passes locally
  • Manual testing (describe below)

Checklist

  • My code follows the project's coding style (go fmt, go vet)
  • I have performed a self-review of my code
  • I have added tests that prove my fix is effective or my feature works
  • New and existing unit tests pass locally with my changes
  • I have updated the documentation accordingly (if applicable)
  • I have signed the CLA

Related Issues

… to Use” heading and before the CLI subsection.
@CLAassistant

CLAassistant commented Jul 1, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@github-actions

github-actions Bot commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

OpenCodeReview: No supported files changed.

@lizhengfeng101

Copy link
Copy Markdown
Collaborator

Thanks for the contribution! I noticed that the changes were synced to README.zh-CN.md, but the other localized README versions also need to be updated:

  • README.ja-JP.md
  • README.ko-KR.md
  • README.ru-RU.md

Could you please sync the Prerequisites section to these files as well? Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants