quickwit-oss/tantivy

Explain the purpose of the query-grammar subcrate

Open

#651 geöffnet am 8. Sept. 2019

Auf GitHub ansehen
 (3 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Rust (499 Forks)batch import
Hacktoberfestgood first issue

Repository-Metriken

Stars
 (8.354 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 12T 14h) (20 gemergte PRs in 30 T)

Beschreibung

Since query-grammar has been moved to a separate crate, we should explain what it's responsible for and how it fits with the rest of the library architecture.

We also moved the recursion_limit to this subcrate, the value of 100 is still prone to failure, which we should test https://github.com/tantivy-search/tantivy/blob/master/query-grammar/src/lib.rs#L1

  • Add a test for recursion limit in query-grammar
  • Add a Readme to query-grammar to explain what it does
  • Edit query-grammar/Cargo.toml to reflect correct keywords etc

Contributor Guide

Research-Richtung
Lesen Sie den Quellcode der query grammar Kiste, verstehen Sie ihre Rolle bei der Tantivy Abfrageanalyse, schreiben Sie eine README, die ihren Zweck erklärt, und fügen Sie einen Test für das Rekursionslimit hinzu.
Tech Stack
rust
Domain
documentationtesting
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitRust
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80