sharkdp/fd

Design and refactoring / general code quality

Open

#382 geöffnet am 4. Jan. 2019

Auf GitHub ansehen
 (15 Kommentare) (1 Reaktion) (0 zugewiesene Personen)Rust (1.059 Forks)batch import
good first issuehelp wanted

Repository-Metriken

Stars
 (42.984 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 15T 23h) (16 gemergte PRs in 30 T)

Beschreibung

This is intended as a tracking issue for general code quality and design discussions. @sharkdp feel free to close this when you think quality has reached an overall satisfactory level.

To start, I'll quote a recent comment by @sharkdp from a discussion on a PR thread:

There are many things I have in mind that would hopefully help to improve the code quality:

  • Group related functions into impl blocks of appropriate structs such that we don't have to pass around so many parameters.
  • Think about a unified interface for filters (file type, file size, modification data, file extension, ..). Maybe a trait-based interface where the filters would be stored in a Vec<Box<dyn Filter>>.
  • Extract some of the functionality like the OsStr-based path handling into separate libraries / crates.

Contributor Guide

Research-Richtung
Dies ist ein Meta Issue für allgemeine Code Qualitätsverbesserungen im fd Repository. Es verweist auf eine PR Diskussion (#309) und schlägt vor, verwandte Funktionen in Struct Impl Blöcke zu gruppieren, eine trait basierte Filter Schnittstelle zu erstellen und die OsStr Pfadbehandlung in separate Crates auszulagern. Es ist keine konkrete Aufgabe definiert, daher sollte ein Neuling zunächst ein spezifisches Code Qualitätsproblem identifizieren, vielleicht durch das Durchsuchen der Codebasis nach Bereichen, denen Modularität oder Dokumentation fehlt, und eine fokussierte Refaktorierung vorschlagen. Der Maintainer (@sharkdp) hat angemerkt, dass dieses Issue geschlossen werden kann, wenn die Qualität zufriedenstellend ist, daher könnte weitere Eingabe der Community erforderlich sein, um umsetzbare Teilaufgaben zu definieren.
Tech Stack
rust
Domain
cli
Issue Type
Refactoring
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
4
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Über 1 Woche
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Meist klar
Voraussetzungen
RustExperience with codebase design
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
20