sharkdp/fd

Design and refactoring / general code quality

Open

#382 ouverte le 4 janv. 2019

Voir sur GitHub
 (15 commentaires) (1 réaction) (0 assignés)Rust (1 059 forks)batch import
good first issuehelp wanted

Métriques du dépôt

Stars
 (42 984 stars)
Métriques de merge PR
 (Merge moyen 15j 23h) (16 PRs mergées en 30 j)

Description

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.

Guide contributeur

Direction de recherche
Il s'agit d'un méta issue pour des améliorations générales de la qualité du code dans le dépôt fd. Il fait référence à une discussion de PR (#309) et suggère de regrouper les fonctions liées dans des blocs d'implémentation de struct, de créer une interface de filtre basée sur des traits et d'extraire la gestion des chemins OsStr dans des crates séparés. Aucune tâche concrète n'est définie, donc un nouveau contributeur doit d'abord identifier un problème spécifique de qualité de code, peut être en parcourant la base de code pour trouver des zones manquant de modularité ou de documentation, et proposer un refactoring ciblé. Le mainteneur (@sharkdp) a noté que cette issue peut être fermée lorsque la qualité est satisfaisante, donc une contribution supplémentaire de la communauté pourrait être nécessaire pour définir des sous tâches actionnables.
Stack technique
rust
Domaine
cli
Type d'issue
Refactorisation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
4
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Plus d'une semaine
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
RustExperience with codebase design
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
20