Feature request: documentation
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 25/100
- Issue 类型
- 文档
- 描述清晰度
- 需要澄清
- 活跃度
- 停滞
- 技术栈
- ruby
调研方向
该 issue 未指定任何文件、测试或入口点。首先调研 gem 的 Ruby 代码及其与 EventMachine 的集成，以梳理需要解释的内容，然后定义文档范围和完成检查清单。完成的标准是：相关代码路径和使用关系已得到充分文档化，足以降低所述的导航成本。
由索引模型根据 Issue 内容生成。
描述
This gem desperately lacks documentation of the code. Navigating the code trying to figure out where something is instantiated and used when using it with my own code that's using EventMachine takes a lot of effort. Documenting the code would make this much easier.
I'm creating this feature request to track this effort.
- 主要语言
- Ruby
- 星标
- 238
- 派生
- 49
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南，环境需要你自己搭建：先看它的 README，通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
faye/websocket-driver-ruby 的其他 Issue
-
难度 3/5 1-2 天 新手友好度 35/100
faye/websocket-driver-ruby#96 · 1 条评论 ·
-
难度 3/5 1-2 天 新手友好度 25/100
faye/websocket-driver-ruby#89 · 1 条评论 ·
-
难度 3/5 1-2 天 新手友好度 35/100
faye/websocket-driver-ruby#86 · 3 条评论 ·
-
难度 4/5 3-5 天 新手友好度 25/100
faye/websocket-driver-ruby#84 · 2 条评论 ·
-
难度 4/5 3-5 天 新手友好度 30/100
faye/websocket-driver-ruby#82 · 4 条评论 · 1 个 reaction ·
查看 faye/websocket-driver-ruby 的全部 Issue
相似的 Issue
-
f:search improvement user-experience
难度 1/5 1 小时以内 新手友好度 82/100
维护者通常 1 天内回复
-
good first issue
难度 2/5 1-3 小时 新手友好度 88/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 73/100
DataDog/datadog-lambda-rb#167 ·
-
难度 2/5 1-3 小时 新手友好度 65/100
alphagov/public-asset-checker#378 · 1 条评论 ·
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 68/100
betagouv/acces-cible#786 ·
维护者通常 1 天内回复