Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

improving the Searcher JS module

未关闭
#1,207 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
45/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
停滞
技术栈
javascript
领域
search

调研方向

首先阅读 lib/rdoc/generator/template/json_index/js/searcher.js,并将其当前的全文搜索和高亮行为与提议的 Fuse.js 方案进行比较。确定合适的 RDoc 测试用例或真实世界示例,然后验证新实现是否匹配或改进了现有行为,并且这些用例能够通过。

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

描述

enhancement

Hello, I'd like to propose a change to the Searcher.js module at lib/rdoc/generator/template/json_index/js/searcher.js, to have this switch to using Fuse.js for its full text searching and highlighting capabilities. That part I can handle in a PR.

What part I got stuck on was how to test that this new implementation would be working as well (or, ideally, better) than the previous one. Are there some test cases that this should be passing within the RDoc project itself or some real-world cases that I could try out?

主要语言
Ruby
星标
929
派生
469
平均合并
1 天 2 小时
30 天内合并 PR
19

环境准备

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

从这里开始

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

ruby/rdoc 的其他 Issue

查看 ruby/rdoc 的全部 Issue

相似的 Issue

更多 Ruby Issue

把新 issue 发到你的邮箱

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