add contributors Download hinzu - add contributors Quellcode -Download hinzu

add contributors

Anderer Quellcode

v0.2.2

Herunterladen

Add-Contributors

Eine Github -Aktion, um Ihre Markdown -Datei (dh Readme.md) automatisch im Zeitplan oder durch Ereignisse ausgelöst zu haben

Speziell umgehen, den nicht erreichbaren chinesischen Kontext (着重解决了中文内容乱码的问题)

Fühlen Sie sich frei, eine Pull -Anfrage oder ein Problem einzureichen. Befolgen Sie jedoch die Vorlagen

Willkommen mit Mitwirkenden, um dieses Projekt gemeinsam zu verbessern!

Verwendung

Erstellen Sie eine Workflow -Datei wie .github/workflows/contributors.yml (Sie finden sie in diesem Repo)

 name : Add contributors
on :
  schedule :
    - cron :  ' 20 20 * * * '
# push:
#   branches:
#     - master

jobs :
  add-contributors :
    runs-on : ubuntu-latest
    steps :
    - uses : actions/checkout@v2
    - uses : BobAnkh/add-contributors@master
      with :
        CONTRIBUTOR : ' ### Contributors '
        COLUMN_PER_ROW : ' 6 '
        ACCESS_TOKEN : ${{secrets.GITHUB_TOKEN}}
        IMG_WIDTH : ' 100 '
        FONT_SIZE : ' 14 '
        PATH : ' /README.md '
        COMMIT_MESSAGE : ' docs(README): update contributors '
        AVATAR_SHAPE : ' round '

Parameter

Parameter	Beschreibung	Erforderlich	Standard
Repo_name	Repository -Name	NEIN	`''` Was bedeutet das aktuelle Repository
Mitwirkender	Wo Sie die Liste der Mitwirkenden hinzufügen möchten	NEIN	`### Contributors`
Column_per_row	Anzahl der Mitwirkenden pro Reihe	NEIN	`6`
Access_token	Github Access Token	Ja	Sie können einfach `${{secrets.GITHUB_TOKEN}}` übergeben
IMG_WIDTH	Breite von IMG	NEIN	`100`
Font_size	Schriftgröße des Namens (PX)	NEIN	`14`
WEG	Pfad zu der Datei, die Sie bei der Liste der Mitwirkenden hinzufügen möchten	NEIN	`/README.md`
ZWEIG	Die in den Pfad angegebene Filiale zum Aktualisieren der Datei	NEIN	`''` Was bedeutet Standardzweig
Pull_Request	Öffnen Sie eine neue Pull -Anfrage, wenn Sie auf einen Zielzweignamen festgelegt werden	NEIN	`''` , was bedeutet, standardmäßig keine Pull -Anfrage zu öffnen
Comment_message	Nachricht begehen	NEIN	`docs(README): update contributors`
Avatar_shape	`round` Sie für runde Avatar und `square` für quadratische Avatar ein	NEIN	Quadrat
Ignored_contributors	Ignorierte Mitwirkende, getrennt von Comma	NEIN	`''`

Hinweis: Sie sollten zum ersten Mal eine leere Linie nach der CONTRIBUTOR hinterlassen
Hinweis: GitHub scheint den Bildstil im Markdown -Datei -Rendering noch nicht zu unterstützen
HINWEIS: IGNORED_CONTRIBUTORS nimmt den Anzeigenamen nicht Benutzername
Hinweis: PULL_REQUEST muss zusammen mit BRANCH verwendet werden. Beide sollten bereitgestellt werden , wenn Sie eine Pull -Anfrage öffnen möchten

Betreuer

@Bobankh

Wie man beiträgt

Sie sollten unserem Verhaltenskodex folgen.

Siehe beitragende Richtlinien für den Beitrag von Konventionen.

Stellen Sie sicher, dass Sie alle Tests bestehen, bevor Sie Ihren Code einreichen. Sie können pytest -ra am Stammverzeichnis durchführen, um alle Tests durchzuführen.

Sie können den lokalen Modus verwenden, wenn Sie ihn auf Ihrer lokalen Maschine entwickeln. Hier finden Sie die Befehlszeileninformationen:

 usage: main.py [-h] [-m MODE] [-f FILE] [-o OUTPUT] [-t TOKEN]

optional arguments:
  -h, --help            show this help message and exit
  -m MODE, --mode MODE  choose to use local-dev mode or on github action mode.
                        Valid values are 'local' or 'github'
  -f FILE, --file FILE  configuration file to read from when running local-dev
                        mode
  -o OUTPUT, --output OUTPUT
                        output file when running local-dev mode
  -t TOKEN, --token TOKEN
                        Github Access Token