sharkdp/fd

Design and refactoring / general code quality

Open

#382 aberto em 4 de jan. de 2019

Ver no GitHub
 (15 comments) (1 reaction) (0 assignees)Rust (1.059 forks)batch import
good first issuehelp wanted

Métricas do repositório

Stars
 (42.984 stars)
Métricas de merge de PR
 (Mesclagem média 15d 23h) (16 fundiu PRs em 30d)

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.

Guia do colaborador

Direção de pesquisa
Esta é uma meta issue para melhorias gerais na qualidade do código no repositório fd. Ela referencia uma discussão de PR (#309) e sugere agrupar funções relacionadas em blocos de implementação de struct, criar uma interface de filtro baseada em traits e extrair o tratamento de caminhos OsStr em crates separados. Nenhuma tarefa concreta está definida, então um novo colaborador deve primeiro identificar um problema específico de qualidade de código, talvez navegando pela base de código em busca de áreas que carecem de modularidade ou documentação, e propor uma refatoração focada. O mantenedor (@sharkdp) observou que esta issue pode ser fechada quando a qualidade for satisfatória, portanto, pode ser necessário mais contribuições da comunidade para definir subtarefas acionáveis.
Pilha de tecnologia
rust
Domain
cli
Tipo Issue
Refatoração
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
4
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Mais de 1 semana
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Antigo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
RustExperience with codebase design
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
20