Skip to content

docs: sync localized README guidance #57

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.

Sign up for GitHub

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

Merged
hex2dec merged 1 commit into from
Apr 2, 2026
Merged

docs: sync localized README guidance #57

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
6 changes: 3 additions & 3 deletions README_CN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 上下文
Expand Down