olistic/warriorjs

Add flag to CLI to generate text READMEs

Open

#47 aberto em 3 de mai. de 2018

Ver no GitHub
 (11 comments) (0 reactions) (0 assignees)JavaScript (528 forks)batch import
good first issuepkg: clistatus: claimedtype: feature

Métricas do repositório

Stars
 (9.168 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

Level READMEs in markdown format could be great if you're using some kind of markdown processor to read them. If you're not planning on doing so, having the markdown syntax laying around creates noise. Running warriorjs --no-markdown should take care of that, and output to README.txt instead of README.md.

Guia do colaborador

Direção de pesquisa
A CLI provavelmente usa um analisador de argumentos de linha de comando como yargs ou commander. Procure o ponto de entrada na pasta `bin/` ou `src/cli`. A flag ` no markdown` deve ser adicionada às opções e, quando presente, escrever `README.txt` em vez de `README.md`. Verifique a lógica atual de geração do README para ver onde a extensão do arquivo é definida. Os comentários existentes podem fornecer orientação sobre as preferências dos mantenedores.
Pilha de tecnologia
javascriptnodejs
Domain
cli
Tipo Issue
Funcionalidade
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.
Meio dia
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.
Claro
Prerequisites
GitNode.js
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70