Instalación de la interfaz de línea de comandos
1. Instalar la herramienta CLI
Este módulo es distribuido vía npm que se incluye con node y debe instalarse como una devDependencies de su proyecto:
yarn add --dev all-contributors-cli # o npm i -D all-contributors-cli
Alternativamente, los usuarios de Arch Linux pueden instalar el paquete all-contributors-cli desde AUR.
The CLI is node based, if you don't wish to add a node dependency use the @all-contributors bot 🤖
2. Inicializar el Proyecto
Inicializar el proyecto con init y responder a algunas preguntas
yarn all-contributors init # o npx all-contributors init
# O ejecutar directamente el bin
./node_modules/.bin/all-contributors init
3. Añadir algunos colaboradores
yarn all-contributors add jfmengels doc
yarn all-contributors generate
Para más información sobre los comandos, consulte el uso del CLI
4. Actualice su documentación de contribución
Considere actualizar su CONTRIBUTING.md o similar con pasos sobre cómo sus colaboradores se pueden añadir. Incluso puede vincular a la documentación de uso de cli .
5. Opcionalmente agregue scripts de comandos de atajos a su package.json
Opcionalmente, puede agregar atajos a sus comandos en el campo de scripts de package.json.
Por ejemplo:
{
"scripts": {
"contributors:add": "all-contributors add",
"contributors:generate": "all-contributors generate"
}
}
Para permitir atajos como
yarn contributors:add jfmengels doc