Correct stale release and Swift build documentation

未关闭 适合新手
#143 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
半天
新手友好度
82/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
活跃
技术栈
swift

调研方向

以引用的章节为起点,将 docs/versioning.md 与 README.md、docs/code-signing.md、docs/homebrew.md 和 AGENTS.md 中关于 release 和 build 的指导进行比较。更新这些文档,使 docs/versioning.md 成为规范文档,DMG 名称与 dispatch 说明保持一致,将无归档的 Swift target 构建与完整的 swift test 区分开来,并且不再存在矛盾。

由索引模型根据 Issue 内容生成。

描述

documentation priority: medium

Problem

Public documentation describes tag-triggered/manual-tag releases even though the workflow is manual-dispatch-only and creates tags itself. It also documents the wrong DMG filename and contradicts itself about whether swift test needs the vendored libghostty archive.

Evidence:

Acceptance criteria

  • Make docs/versioning.md the canonical release procedure.
  • Correct DMG names and dispatch instructions.
  • Document archive-free Swift target builds separately from full swift test.
  • Remove contradictory instructions.
主要语言
Rust
星标
0
派生
0
PR 合并指标
30 天内没有已合并 PR

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

richardcase/clowder 的其他 Issue

查看 richardcase/clowder 的全部 Issue

相似的 Issue

更多 Rust Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。