Skip to content

[AI Generated][DOCS] 优化 README 并新增中文版 - #1

Merged
ouyangjiahong26 merged 3 commits into
masterfrom
chore/repo-polish
Sep 28, 2026
Merged

ouyangjiahong26 merged 3 commits into
masterfrom
chore/repo-polish

Conversation

@ouyangjiahong26

Copy link
Copy Markdown
Contributor

关联 issue

无关联 issue。

改动摘要(3 个 commit)

  1. docs: 优化 README 并新增中文版
    • 英文 README:语言切换行、CI/crates.io/docs.rs/license 徽章、目录、Documentation 节;Quickstart 依赖版本修正为 0.1 并补 MSRV 说明;新增 Basic Workflow 五步标准流程(SOP);每个示例配适用场景导语与 LaTeX 公式(公式数值经 symcas 实测核对)。
    • 新增 README.zh-CN.md 完整镜像:代码块与英文版逐字节一致,正文翻译,arena 等术语保留英文。
  2. chore(ci): 新增 Release 工作流、Dependabot 与 Issue/PR 模板
    • 推送 v* 标签自动创建 GitHub Release(不含 crates.io 发布);Dependabot 每周检查 cargo 与 github-actions;Issue 表单与 PR 检查清单。沿用 ci.yml 约定(major tag、persist-credentials: false、concurrency、最小 permissions)。
  3. chore: homepage 指向 docs.rs 并同步陈旧的 Cargo.lock
    • workspace homepage 改为 https://docs.rs/symcas;Cargo.lock 同步 0.1.1 清单(修复 master 上 cargo --locked 门禁因陈旧 lock 失败的问题;仅成员版本号 0.1.0→0.1.1,无依赖变更)。

另:远端仓库元数据(description / homepage / 7 个 topics)已经 gh repo edit 生效,不在本 PR 内。

测试

  • cargo fmt --all -- --check ✓
  • cargo clippy --workspace --all-targets --locked -- -D warnings ✓
  • cargo test --workspace --locked ✓(17 组 74 测试,0 失败)
  • 全部 .github YAML 语法校验 ✓;中英 README 6 个代码块逐字节一致;相对链接目标均存在;破折号零残留

英文 README:语言切换行、CI/crates.io/docs.rs/license 徽章、目录、Documentation 节、Quickstart 依赖版本修正为 0.1、Basic Workflow 五步 SOP、每个示例补充适用场景与 LaTeX 公式。新增 README.zh-CN.md 完整镜像(代码块与英文版逐字节一致,正文翻译,arena 等术语保留英文)。五个代码示例区块保持不动。
Release 工作流在推送 v* 标签时经 gh CLI 自动创建 GitHub Release(不含 crates.io 发布);Dependabot 每周检查 cargo 与 github-actions 依赖;Issue 表单(bug report / feature request)与 PR 检查清单模板。沿用 ci.yml 约定:major tag、persist-credentials: false、concurrency、最小 permissions。
workspace homepage 由 GitHub 仓库地址改为 https://docs.rs/symcas。Cargo.lock 同步 0.1.1 清单:升版提交未刷新 lock,master 上 cargo --locked 门禁(clippy/test)因此失败,本提交一并修复(仅成员版本号 0.1.0→0.1.1,无依赖变更)。
@ouyangjiahong26
ouyangjiahong26 merged commit 441243d into master Sep 28, 2026
1 check passed
@ouyangjiahong26
ouyangjiahong26 deleted the chore/repo-polish branch September 28, 2026 12:50
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.

1 participant