RhoMD Docs Download

Community

怎么提问 / 报 bug / 贡献 PR / 找其他 Rho 用户。

渠道

渠道 用途
GitHub Issues Bug 报告 / feature request / spec 问题
GitHub Issues 一般问题 / "how do I..." / 经验分享 / 投票
GitHub PR 代码 / 文档贡献
[email protected] 商业 license / 私下 / 安全 / 合作

报 Bug

提 issue 前

  1. 搜 open issues 确认没人提过
  2. 试在最新 @rho/md 版本复现
  3. 简化到最小复现例（minimal reproducible example）

Issue 模板

**Bug 描述**
（一句话）

**复现步骤**
1. 装 @rho/md v0.x
2. 跑 ...
3. 看到 ...

**期望行为**
应该 ...

**实际行为**
但实际 ...

**最小复现源**
\```markdown
（最小例子）
\```

**环境**
- Rho 版本：v0.x
- Node 版本：18.x
- 浏览器：Chrome 120 / Safari 17 / etc.
- OS：macOS 14 / Linux Ubuntu 22.04 / etc.

提 Feature Request

提之前

读 Roadmap——可能已经规划。

Issue 模板

**问题**
（你想解决什么 use case？）

**现有 workaround**
（目前怎么 work-around 的）

**期望行为**
（如果 Rho 支持，会怎么用？）

**优先级**
（对你 / 你团队多关键？）

**愿意贡献 PR 吗**
（是 / 否 / 部分）

贡献 PR

Fork + setup

git clone [email protected]:YOUR_USERNAME/markview.git
cd markview
npm install
npm run dev      # 启 dev server
npm test         # 跑测试

命名 branch

git checkout -b fix/callout-empty-body
git checkout -b feat/audio-embed
git checkout -b docs/quickstart-typo

Commit style

按 Conventional Commits：

fix: callout empty body crash
feat: audio embed support (closes #123)
docs: typo in quickstart
chore: bump deps
test: add coverage for nested layout

PR checklist

  • 测试通过 (npm test)
  • 新功能有对应测试
  • 改了 spec 行为 → 更新 docs
  • Linked issue（如有）
  • 跑过 lint (npm run lint)

Review 流程

  1. 你提 PR
  2. CI 跑
  3. Maintainer review（通常 3-7 天）
  4. 反馈 / 改
  5. Merge → 下个 minor 版本发布

贡献文档

文档是社区最容易上手的贡献方向：

  • 修 typo / clarity
  • 补缺失的例子
  • 翻译（中→英 / 英→其他）
  • 真实用例分享

文档路径：站点仓库里的 src/docs-content/（尚未公开——改进建议请走 GitHub Issues）

文档 PR 跟代码 PR 流程一样——但 review 通常更快（< 3 天）。

提问规范

Discussion 适合

  • "我想用 Rho 做 X，怎么开始？"
  • "为什么 mini DSL 没有 if/else？"
  • "你们怎么用 Rho 在生产？" 经验分享
  • "这个用例 Rho 适合吗？"

Issue 适合

  • "Bug：layout cols=4 在窄屏上变 5 列"
  • "Feature：希望 modal 支持 keyboard ESC 关闭"
  • "Spec 不清楚：annotate 范围 0-based 还是 1-based？"

邮件适合

  • 商业 license 询价
  • Security vulnerability 报告（不要 open public issue）
  • 私下 partnership 提案
  • 媒体询问

行为准则 (Code of Conduct)

scos-lab 项目遵循 Contributor Covenant 2.1：

  • ✅ 尊重不同观点 / 经验 / 背景
  • ✅ 提建设性反馈
  • ✅ 假定善意
  • ❌ 人身攻击 / 骚扰 / 歧视
  • ❌ 政治 / 宗教 / 个人攻击

违反 → 邮件 [email protected]，调查后可能 ban。

安全 vulnerability 报告

不要 open public issue —— 安全问题需要先 patch 再公开。

→ 邮件 [email protected]，subject [SECURITY]

我们：

  • 24h 内确认收到
  • 7 天内评估严重性
  • patch 发布后联合披露（CVE 等级看严重性）

不会对 security reporter 报复——bug bounty 计划 v1.0 后启动。

媒体 / 演讲

写文章 / 录视频 / 做 talk 介绍 Rho？

  • ✅ 完全欢迎——无需提前许可
  • ✅ 可用 press kit 素材（尚未发布）
  • ✅ 想要采访 / 内部 demo → 邮件 [email protected]

学习资源

关于 scos-lab

scos-lab 是 Rho format spec / @rho/md library / Rho desktop app / cloud.rho.md 的维护者。

See also