From 5f00375667ef60f622b40fa78f985314fd0f4023 Mon Sep 17 00:00:00 2001 From: Zhiwei Huang Date: Thu, 2 Apr 2026 15:23:48 +0800 Subject: [PATCH] docs: sync localized README guidance --- AGENTS.md | 3 +++ README_CN.md | 6 +++--- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 3f033a2..ed6ebcd 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -24,5 +24,8 @@ Favor integration tests that exercise the compiled binary with `assert_cmd`. Moc ## Commit & Pull Request Guidelines Recent history includes both plain commit subjects such as `feat: add auth CLI skeleton` and historical subjects suffixed with `(#13)`. Treat the `(#13)` style as repository history, not as the default format for new handwritten commits. Prefer a short imperative subject, optionally prefixed with `feat:` or `chore:`, and do not append PR numbers to manual commit messages unless the user explicitly asks for that format. If an issue or PR reference matters, put it in the PR title, PR description, or linked metadata instead of the commit subject. GitHub pull requests and issues should be written in English. PRs should describe the user-visible CLI change, list validation commands run, and include sample output when flags, JSON payloads, or exit codes change. +## Documentation Guidelines +Keep `README.md` and `README_CN.md` in sync for user-facing behavior, install steps, command examples, release/platform notes, and workflow guidance. When one of those files changes, update the other in the same change unless there is a deliberate language-specific exception and you call it out explicitly. + ## Security & Configuration Tips Never commit real Gitee tokens. Runtime configuration is read from `GITEE_TOKEN`, `GITEE_CONFIG_DIR`, `XDG_CONFIG_HOME`, `HOME`, `USERPROFILE`, `HOMEDRIVE`, and `HOMEPATH`; persisted credentials default to `~/.config/gitee/config.toml` when `GITEE_CONFIG_DIR` is not set. Use `GITEE_BASE_URL` only for tests or local API mocking. diff --git a/README_CN.md b/README_CN.md index 9399156..3b66837 100644 --- a/README_CN.md +++ b/README_CN.md @@ -154,16 +154,16 @@ gitee repo view --repo octo/demo --json gitee repo view --json ``` -默认使用 HTTPS 克隆： +使用已保存的克隆协议偏好；首次使用时选择 SSH 或 HTTPS： ```bash gitee repo clone octo/demo ``` -使用 SSH 克隆到指定目录： +使用 HTTPS 克隆到指定目录： ```bash -gitee repo clone octo/demo demo-ssh --ssh --json +gitee repo clone octo/demo demo-https --https --json ``` ### 在修改代码前先阅读 Issue 上下文