Edit

Uso CLI

Esta documentação de uso presume que você já seguiu os passos para a instalação da cli.

Breve nota: Abaixo nós mostraremos apenas o all-contributors para simplificar as coisas, mas se você está tendo dificuldades, tente a rota do yarn all-contributors 😺

Comandos

all-contributors init

Execute isso para começar a usar a all-contributors-cli. Este comando faz algumas perguntas e prepara o projeto para o all-contributors. As preparações incluem criar um arquivo de configuração chamado .all-contributorsrc e criar uma tabela de contribuidores nos arquivos que você especificar (geralmente o seu README.md).

all-contributors add

Use o comando add para adicionar novos contribuidores ao seu projeto, ou novas maneiras nas quais eles contribuíram. Eles serão adicionados ao seu arquivo de configuração, e o arquivo de contribuidores será atualizado como se você tivesse usado o comando generate .

# Adicionar contribuidor <username>, que fez uma contribuição do tipo <contribution> 
all-contributors add <username> <contribution>
# Exemplo:
 all-contributors add jfmengels code,doc

Aonde username é o nome do usuário no GitHub ou GitLab, e contribution é uma lista separada por , de contribuições. Veja a tabela-de-emoji (Referência de Tipos de Contribuição) para uma lista de tipos de contribuição válidos.

Usuários do GitLab: Vide os requisitos adicionais para usuários do GitLab

all-contributors check

Use check para comparar contribuidores do GitHub com os reditados no seu arquivo .all-contributorsrc, para certificar-se de que os créditos foram dados devidamente.

Devido a restrições da API do GitHub, esse comando só funciona para projetos com menos de 500 contribuidores (A não ser que você estabeleça um PRIVATE_TOKEN conforme mencionado abaixo em usuários do GitHub).

all-contributors generate

Use generate para ler a lista de contribuidores do seu arquivo .all-contributorsrc e atualizar as tabelas de contribuidores especificadas na chave files.

Observe que o comando precisa achar as seguintes tags em tais arquivos para atualizar a tabela:

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- ALL-CONTRIBUTORS-LIST:END -->

Also note that it needs to find the following tags in order to update the badge:

<!-- ALL-CONTRIBUTORS-BADGE:START - Não remova ou modifique esta sessão -->
<!-- ALL-CONTRIBUTORS-BADGE:END -->

Usuários do GitHub

Em alguns casos você pode ver a mensagem de erro GitHub API rate limit exceeded for xxx. Você pode precisar definir uma variável de ambiente chamada PRIVATE_TOKEN para contornar a taxa limite do GitHub.

PRIVATE_TOKEN é o seu token de acesso para autenticação com a API do GitHub.

Usuários do GitLab

Observe que se você usa uma instância do gitlab hospedada por conta, alguns comandos precisarão que você defina uma variável de ambiente chamada PRIVATE_TOKEN antes.

PRIVATE_TOKEN é o seu token de acesso para autenticação com a API do GitLab.

# definir token privado no Linux
export PRIVATE_TOKEN=seu_token_privado
# definir token privado no Windows
set PRIVATE_TOKEN=seu_token_privado

O que vem a seguir

← InstalaçãoConfiguração →