Edit

Instalacja CLI

1. Install the CLI tool

Wersja NPM AUR Version

Moduł ten jest rozpowszechniany za pośrednictwem npm npm, które instalowane jest wraz z node i powinien być zainstalowany w projekcie jako devDependencies:

yarn add --dev all-contributors-cli # albo npm i -D all-contributors-cli

Alternatively, Arch Linux users can install the all-contributors-cli package from the AUR.

The CLI is node based, if you don't wish to add a node dependency use the @all-contributors bot 🤖

2. Zainicjuj Projekt

Zainicjuj projekt za pomocą komendy init i odpowiedz na kilka pytań

yarn all-contributors init # albo npx all-contributors init 

# Lub wykonać bezpośrednio bin
./node_modules/.bin/all-contributors init

3. Dodaj kilku kontrybutorów

yarn all-contributors add jfmengels doc
yarn all-contributors generate

Więcej informacji na temat komend znajdziesz w CLI usage

4. Zaktualizuj dokumentację kontrybucji

Rozważ rozszerzenie pliku CONTRIBUTING.md o kroki, dzięki którym Contributors będą mogli dodać samych siebie do listy. W tym celu możesz nawet skorzystać z dokumentacji użytkowania bota.

5. Opcjonalnie dodaj skrót do scripts w package.json

Możesz również dodać skróty swoich komend w package.json w polu scripts.

Na przykład:

{
  "scripts": {
    "contributors:add": "all-contributors add",
    "contributors:generate": "all-contributors generate"
  }
}

Aby zezwolić na komendy takie jak

yarn contributors:add jfmengels doc

Co dalej

← PrzeglądKorzystanie →