BurntSushi/ripgrep

ngram indexing implementation details

Open

#1,518 opened on Mar 16, 2020

View on GitHub
 (17 comments) (0 reactions) (0 assignees)Rust (2,559 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (63,768 stars)
PR merge metrics
 (Avg merge 2d 12h) (5 merged PRs in 30d)

Description

This is split off from #1497 as a space to discuss specific implementation details of the indexing strategy. I'd like to keep this discussion separate so that folks won't feel put off from participating in a higher level discussion around the UX.

TODO: I'll fill in a sketch of my high level plan when I get a chance.

Contributor guide

Research direction
Participate in the discussion to help shape the ngram indexing implementation plan. Focus on understanding the trade offs between different indexing strategies and how they can be integrated into ripgrep's existing search architecture.
Tech stack
rust
Domain
clitooling
Issue type
Research
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Needs maintainer response
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Unclear
Prerequisites
RustGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30