Instalação do CLI
1. Instalar ferramenta de CLI
Este módulo é distribuído através do npm que é empacotado com Node e deve ser instalado como parte devDependencies:
yarn add --dev all-contributors-cli # ou npm i -D all-contributors-cli
Alternativamente, usuários de Arch Linux podem instalar o pacote all-contributors-cli do AUR.
The CLI is node based, if you don't wish to add a node dependency use the @all-contributors bot 🤖
2. Inicie o Projeto
Inicie o projeto usando init e responda algumas perguntas
yarn all-contributors init # ou npx all-contributors init
# Ou execute diretamente o arquivo .bin
./node_modules/.bin/all-contributors init
3. Adicione alguns contribuidores
yarn all-contributors add jfmengels doc
yarn all-contributors generate
Para saber mais sobre os comandos, veja o Uso da CLI
4. Atualizar sua documentação sobre contribuição
Considere atualizar seu arquivo CONTRIBUTING.md, ou outro similar, com os passos sobre como seus contribuidores podem se registrar. Você pode também fazer um link para a documentação de uso da CLI.
5. Opcionalmente adicione scripts de atalho em seu package.json
Você pode opcionalmente adicionar atalhos para comandos no seu package.json, na seção scripts.
Por exemplo:
{
"scripts": {
"contributors:add": "all-contributors add",
"contributors:generate": "all-contributors generate"
}
}
Para permitir atalhos como
yarn contributors:add jfmengels doc