ruby/rdoc

登录后关注 在 GitHub 查看

RDoc produces HTML and online documentation for Ruby projects.

ruby/rdoc 对新手友好吗？

ruby/rdoc 的维护者通常 1 天内回复 PR。 目前有 2 个适合新手的 issue 开放。

星标
928
派生
471
开放的新手 issue
2
已索引 issue
129
平均合并
2 天 4 分钟
30 天内合并 PR
13
主要语言
Ruby
许可证
没有许可证数据
最近 GitHub push
2026年10月27日
最近索引
2026年9月19日
贡献指南
没有行为准则
新手标签
没有已索引的新手标签

如何为 ruby/rdoc 做贡献

  1. 先读贡献指南：它说明了维护者希望如何提出、测试和评审改动。
  2. 从下方 2 个开放的新手友好 issue 中选一个，开始之前先留言说明你想认领它。
适合新手 全部
未关闭 全部

可能已有人在做的 issue 排在最后。 全部按时间排序

  • Spaces in image alt texts are not supported
    未关闭
    • 哪里不对？

    难度 2/5 1-3 小时 新手友好度 72/100

    ruby/rdoc#1870 ·

    维护者通常 1 天内回复

  • module_function without arguments is not applied to subsequent method definitions
    未关闭
    • 哪里不对？
    enhancement

    难度 4/5 3-5 天 新手友好度 68/100

    ruby/rdoc#1823 · 5 条评论 ·

    维护者通常 1 天内回复

  • Consider renaming the title on `docs.ruby-lang.org` for better SEO
    未关闭
    • 哪里不对？

    难度 3/5 1-2 天 新手友好度 58/100

    ruby/rdoc#1810 ·

    维护者通常 1 天内回复

  • Incorrect aliasing
    未关闭
    • 哪里不对？

    难度 5/5 一周以上 新手友好度 25/100

    ruby/rdoc#1764 ·

    维护者通常 1 天内回复

  • Prism parser no longer accepts legacy ghost method directives without a leading colon
    未关闭
    • 哪里不对？

    难度 3/5 1-2 天 新手友好度 76/100

    ruby/rdoc#1760 · 6 条评论 · 1 个 reaction ·

    维护者通常 1 天内回复

  • Prism parser ignores attr_* calls with trailing keyword arguments
    未关闭
    • 哪里不对？

    难度 2/5 1-3 小时 新手友好度 85/100

    ruby/rdoc#1759 · 1 条评论 ·

    维护者通常 1 天内回复

  • main page file deduplication & broken links with rdoc 8
    未关闭
    • 哪里不对？

    难度 4/5 3-5 天 新手友好度 48/100

    ruby/rdoc#1750 ·

    维护者通常 1 天内回复

  • RDoc needs a directive to not clobber an overridden method definition's documentation, but add to it.
    未关闭
    • 哪里不对？

    难度 4/5 3-5 天 新手友好度 45/100

    ruby/rdoc#1716 · 1 条评论 ·

    维护者通常 1 天内回复

  • How to put invisible comment in included file?
    未关闭
    • 哪里不对？

    难度 3/5 1-2 天 新手友好度 45/100

    ruby/rdoc#1691 · 2 条评论 ·

    维护者通常 1 天内回复

  • Restore ability to disable cross references for inline `tt`
    未关闭
    • 哪里不对？

    难度 4/5 3-5 天 新手友好度 35/100

    ruby/rdoc#1643 · 2 条评论 ·

    维护者通常 1 天内回复

  • How to handle tool-specific magic comments
    未关闭
    • 哪里不对？

    难度 4/5 3-5 天 新手友好度 35/100

    ruby/rdoc#1614 · 1 条评论 · 2 个 reaction ·

    维护者通常 1 天内回复

  • Consider displaying accessors (`Attributes`) in sidebar or merging with Instance Methods
    未关闭
    • 哪里不对？

    难度 3/5 1-2 天 新手友好度 45/100

    ruby/rdoc#1579 · 2 条评论 · 1 个 reaction ·

    维护者通常 1 天内回复

  • Accept misused :nodoc: usage
    未关闭
    • 哪里不对？

    难度 5/5 一周以上 新手友好度 35/100

    ruby/rdoc#1578 · 1 个 reaction ·

    维护者通常 1 天内回复

  • Aliki: Hard to discern method blocks visually
    未关闭
    • 哪里不对？

    难度 3/5 1-2 天 新手友好度 45/100

    ruby/rdoc#1573 · 2 条评论 ·

    维护者通常 1 天内回复

  • Support multi-word backticks like `some code` in RDoc
    未关闭
    • 哪里不对？

    难度 3/5 1-2 天 新手友好度 48/100

    ruby/rdoc#1565 · 1 条评论 ·

    维护者通常 1 天内回复

  • Aliki(?): sidebar should be expanded to show current namespacing
    未关闭
    • 哪里不对？

    难度 3/5 1-2 天 新手友好度 38/100

    ruby/rdoc#1556 · 1 个 reaction ·

    维护者通常 1 天内回复

  • Aliki: can't click on top namespace?
    未关闭
    • 哪里不对？

    难度 3/5 1-2 天 新手友好度 35/100

    ruby/rdoc#1554 · 1 条评论 ·

    维护者通常 1 天内回复

  • Don't include method documentation for aliased methods
    未关闭
    • 哪里不对？

    难度 4/5 3-5 天 新手友好度 42/100

    ruby/rdoc#1533 · 1 个 reaction ·

    维护者通常 1 天内回复

  • token_stream and skip_document inconsistency
    未关闭
    • 哪里不对？

    难度 4/5 3-5 天 新手友好度 35/100

    ruby/rdoc#1492 · 1 条评论 ·

    维护者通常 1 天内回复

  • Aliki: Add go-to-ruby playground link to Ruby code blocks
    未关闭
    • 哪里不对？
    enhancement

    难度 3/5 1-2 天 新手友好度 45/100

    ruby/rdoc#1452 · 2 个 reaction ·

    维护者通常 1 天内回复

  • Aliki: Support customizing top navbar items
    未关闭
    • 哪里不对？
    enhancement

    难度 5/5 一周以上 新手友好度 20/100

    ruby/rdoc#1450 ·

    维护者通常 1 天内回复

  • Undocumented items in TAGS style
    未关闭
    • 哪里不对？
    Feature Request

    难度 3/5 1-2 天 新手友好度 38/100

    ruby/rdoc#1446 · 1 个 reaction ·

    维护者通常 1 天内回复

  • Provide a way to configure weights for class/module search result
    未关闭
    • 哪里不对？
    enhancement

    难度 5/5 一周以上 新手友好度 25/100

    ruby/rdoc#1445 ·

    维护者通常 1 天内回复

  • Can a paragraph contain blocks?
    未关闭
    • 哪里不对？
    documentation

    难度 2/5 1-3 小时 新手友好度 48/100

    ruby/rdoc#1414 ·

    维护者通常 1 天内回复

  • Is text markup a block?
    未关闭
    • 哪里不对？
    documentation

    难度 5/5 一周以上 新手友好度 25/100

    ruby/rdoc#1413 ·

    维护者通常 1 天内回复

  • Problem due to commit 75d15117643d17a3c3d92b41512bd7840c91705b included with 6.12.0
    未关闭
    • 哪里不对？

    难度 4/5 3-5 天 新手友好度 35/100

    ruby/rdoc#1394 · 1 条评论 ·

    维护者通常 1 天内回复

  • rdoc 6.13.1 does not detect `private :new`
    未关闭
    • 哪里不对？

    难度 3/5 1-2 天 新手友好度 55/100

    ruby/rdoc#1364 ·

    维护者通常 1 天内回复

  • Review and possibly upstream `sdoc`'s RDoc patches
    未关闭
    • 哪里不对？

    难度 5/5 一周以上 新手友好度 20/100

    ruby/rdoc#1333 · 1 个 reaction ·

    维护者通常 1 天内回复

  • Add a CI job for SDoc
    未关闭
    • 哪里不对？

    难度 3/5 1-2 天 新手友好度 35/100

    ruby/rdoc#1331 · 5 条评论 ·

    维护者通常 1 天内回复

  • Support for Java classes in JRuby
    未关闭
    • 哪里不对？

    难度 5/5 一周以上 新手友好度 32/100

    ruby/rdoc#1327 ·

    维护者通常 1 天内回复

  • Linear performance test times out intermittently on JRuby
    未关闭
    • 哪里不对？

    难度 4/5 3-5 天 新手友好度 35/100

    ruby/rdoc#1310 · 3 条评论 ·

    维护者通常 1 天内回复

  • Bold and Italic must be available in current font color
    未关闭
    • 哪里不对？

    难度 4/5 3-5 天 新手友好度 25/100

    ruby/rdoc#1288 ·

    维护者通常 1 天内回复

  • Support for <details> and <summary>
    未关闭
    • 哪里不对？
    Feature Request

    难度 4/5 3-5 天 新手友好度 42/100

    ruby/rdoc#1287 · 1 条评论 ·

    维护者通常 1 天内回复

  • Alias for attribute causes aliasing method to appear in Attributes section
    可能重新可做 未关闭
    • 哪里不对？
    bug

    难度 3/5 1-2 天 新手友好度 45/100

    ruby/rdoc#1286 · 5 条评论 ·

    维护者通常 1 天内回复

  • RDoc::RDoc #parse_file does not work
    未关闭
    • 哪里不对？

    难度 2/5 1-3 小时 新手友好度 52/100

    ruby/rdoc#1268 · 1 条评论 ·

    维护者通常 1 天内回复

  • Missing files in .../share/doc/ruby/html/
    未关闭
    • 哪里不对？
    bug

    难度 3/5 1-2 天 新手友好度 50/100

    ruby/rdoc#1224 · 1 条评论 ·

    维护者通常 1 天内回复

  • Trouble with Developer Quick Start
    未关闭
    • 哪里不对？

    难度 4/5 3-5 天 新手友好度 32/100

    ruby/rdoc#1223 · 2 条评论 ·

    维护者通常 1 天内回复

  • improving the Searcher JS module
    未关闭
    • 哪里不对？
    enhancement

    难度 3/5 1-2 天 新手友好度 45/100

    ruby/rdoc#1207 ·

    维护者通常 1 天内回复

  • List child classes in the sidebar
    可能重新可做 未关闭
    • 哪里不对？
    enhancement

    ruby/rdoc#1201 · 已指派 1 人 ·

    维护者通常 1 天内回复

  • Allow sites to specify favicon
    未关闭
    • 哪里不对？
    enhancement

    难度 4/5 3-5 天 新手友好度 45/100

    ruby/rdoc#1192 ·

    维护者通常 1 天内回复

  • End to end testing for `RDoc#generate`
    未关闭
    • 哪里不对？

    难度 3/5 1-2 天 新手友好度 48/100

    ruby/rdoc#1180 · 1 条评论 ·

    维护者通常 1 天内回复

  • Trying to run `rake rdoc` without pre-existing main file raises an error
    未关闭
    • 哪里不对？

    难度 3/5 1-2 天 新手友好度 52/100

    ruby/rdoc#1177 ·

    维护者通常 1 天内回复

  • Needs a parse tree for C files
    未关闭
    • 哪里不对？

    难度 5/5 一周以上 新手友好度 30/100

    ruby/rdoc#1168 · 2 条评论 ·

    维护者通常 1 天内回复

  • RDoc color scheme
    未关闭
    • 哪里不对？

    难度 5/5 一周以上 新手友好度 25/100

    ruby/rdoc#1164 · 5 条评论 ·

    维护者通常 1 天内回复

  • Questions about file selection
    未关闭
    • 哪里不对？

    难度 3/5 1-2 天 新手友好度 25/100

    ruby/rdoc#1163 · 2 条评论 ·

    维护者通常 1 天内回复

  • `RDoc::Parser::ChangeLog` doesn't handle keep-a-changelog style CHANGELOG correctly
    未关闭
    • 哪里不对？

    难度 4/5 3-5 天 新手友好度 35/100

    ruby/rdoc#1133 ·

    维护者通常 1 天内回复

  • [Proposal] Add user guide, especially about directives
    未关闭
    • 哪里不对？

    难度 5/5 一周以上 新手友好度 25/100

    ruby/rdoc#1119 · 3 条评论 ·

    维护者通常 1 天内回复

  • More documentation for methods in RDoc
    未关闭
    • 哪里不对？

    难度 5/5 一周以上 新手友好度 25/100

    ruby/rdoc#1111 ·

    维护者通常 1 天内回复

  • rdoc non-determinism: module includes can be added once or twice to generated .ri
    未关闭
    • 哪里不对？
    bug

    难度 4/5 3-5 天 新手友好度 35/100

    ruby/rdoc#1084 ·

    维护者通常 1 天内回复

  • Internationalize hardcoded rdoc-ref links
    未关闭
    • 哪里不对？
    bug

    难度 5/5 一周以上 新手友好度 25/100

    ruby/rdoc#1076 · 1 条评论 ·

    维护者通常 1 天内回复

只显示最新的 100 条

这个页面只列出最近收录的部分。完整清单在高级筛选里，可以按语言、难度和预计耗时筛选。

前往高级筛选

把新 issue 发到你的邮箱

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