RhoMD Docs Download

Community

How to ask questions / report bugs / contribute PRs / find other Rho users.

Channels

Channel Use
GitHub Issues Bug reports / feature requests / spec questions
GitHub Issues General questions / "how do I..." / experience sharing / votes
GitHub PR Code / docs contributions
[email protected] Commercial license / private / security / partnership

Reporting bugs

Before filing an issue

  1. Search open issues to confirm not already filed
  2. Try reproducing on the latest @rho/md version
  3. Reduce to a minimal reproducible example

Issue template

**Bug description**
(One sentence)

**Steps to reproduce**
1. Install @rho/md v0.x
2. Run ...
3. See ...

**Expected behavior**
Should ...

**Actual behavior**
Actually ...

**Minimal reproduction**
\```markdown
(Minimal example)
\```

**Environment**
- Rho version: v0.x
- Node version: 18.x
- Browser: Chrome 120 / Safari 17 / etc.
- OS: macOS 14 / Linux Ubuntu 22.04 / etc.

Filing feature requests

Before filing

Read Roadmap — may already be planned.

Issue template

**Problem**
(What use case are you solving?)

**Existing workaround**
(How do you currently work around this?)

**Expected behavior**
(If Rho supported this, how would you use it?)

**Priority**
(How critical for you / your team?)

**Willing to contribute PR**
(Yes / No / Partial)

Contributing PRs

Fork + setup

git clone [email protected]:YOUR_USERNAME/markview.git
cd markview
npm install
npm run dev      # Start dev server
npm test         # Run tests

Naming branches

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

Commit style

Follows 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

  • Tests pass (npm test)
  • New features have corresponding tests
  • Spec behavior changed → update docs
  • Linked issue (if any)
  • Lint passes (npm run lint)

Review flow

  1. You file PR
  2. CI runs
  3. Maintainer reviews (typically 3-7 days)
  4. Feedback / revisions
  5. Merge → released in next minor version

Contributing docs

Docs are the easiest entry point for community contribution:

  • Fix typos / clarity
  • Add missing examples
  • Translate (CN→EN / EN→other languages)
  • Share real-world use cases

Docs path: src/docs-content/ in the rho.md site repository (not public yet — send corrections through GitHub Issues)

Docs PRs follow the same flow as code PRs — but reviews usually faster (< 3 days).

Question etiquette

Discussions are for

  • "I want to use Rho for X, where do I start?"
  • "Why doesn't mini DSL have if/else?"
  • "How do you use Rho in production?" experience sharing
  • "Is this use case suitable for Rho?"

Issues are for

  • "Bug: layout cols=4 shows as 5 columns on narrow screens"
  • "Feature: hope modal supports keyboard ESC to close"
  • "Spec unclear: is annotate range 0-based or 1-based?"

Email is for

  • Commercial license inquiries
  • Security vulnerability reports (don't open public issue)
  • Private partnership proposals
  • Press inquiries

Code of Conduct

scos-lab projects follow Contributor Covenant 2.1:

  • ✅ Respect different views / experiences / backgrounds
  • ✅ Offer constructive feedback
  • ✅ Assume good intent
  • ❌ Personal attacks / harassment / discrimination
  • ❌ Political / religious / personal attacks

Violation → email [email protected]; possible ban after investigation.

Security vulnerability reports

Don't open a public issue — security issues need patches first, then disclosure.

→ Email [email protected] with subject [SECURITY]

We:

  • Confirm receipt within 24h
  • Assess severity within 7 days
  • Joint disclosure after patch release (CVE level depending on severity)

We won't retaliate against security reporters — bug bounty program launching post-v1.0.

Media / talks

Want to write articles / record videos / give talks introducing Rho?

  • ✅ Fully welcomed — no advance permission needed
  • ✅ Can use press kit assets (not published yet)
  • ✅ Want interview / private demo → email [email protected]

Learning resources

About scos-lab

scos-lab is the maintainer of Rho format spec / @rho/md library / Rho desktop app / cloud.rho.md.

See also