mandiant/capa

review clig.dev for CLI guidelines

Open

#1.686 aberto em 7 de ago. de 2023

Ver no GitHub
 (15 comments) (0 reactions) (0 assignees)Python (703 forks)github user discovery
enhancementhelp wantedusability

Métricas do repositório

Stars
 (6.043 stars)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

take inspiration from https://clig.dev/ for best practices when it comes to CLI tools, like capa.

don't necessarily re-write things to adhere to the style, especially when we already have a working solution. however, if they have some good suggestions, see if we can incorporate them as appropriate.

i'll mark this as #help-wanted and #good-first-issue so that contributors can take suggestions from the items below and propose changes in dedicated PRs and issues. note: before spending a lot of time addressing one of these points, please coordinate with us to ensure we all agree on the design and/or wording.

Guia do colaborador

Direção de pesquisa
Leia as diretrizes de CLI em clig.dev, compare com o comportamento e saída atuais do capa e proponha melhorias específicas criando PRs ou issues dedicados. Coordene com os mantenedores antes de implementar mudanças significativas.
Pilha de tecnologia
python
Domain
cli
Tipo Issue
Documentaçã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.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75