add contributors - add contributors Télécharger

add contributors

Autre code source

v0.2.2

Télécharger

compromis

Une action GitHub pour ajouter des contributeurs à votre fichier de démarrage (c'est-à-dire Readme.md) automatiquement sous le calendrier ou déclenché par des événements

Gérer spécifiquement le contexte chinois inaccessible (着重解决了中文内容乱码的问题)

N'hésitez pas à soumettre une demande de traction ou un problème, mais assurez-vous de suivre les modèles

Bienvenue aux contributeurs pour améliorer ce projet ensemble!

Usage

Créez un fichier de workflow tel que .github/workflows/contributors.yml (vous pouvez le trouver dans ce 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 '

Paramètres

Paramètre	Description	Requis	Défaut
Nom_	Nom de référentiel	Non	`''` Ce qui signifie le référentiel actuel
DONATEUR	Où vous souhaitez ajouter la liste des contributeurs	Non	`### Contributors`
Column_per_row	Nombre de contributeurs par ligne	Non	`6`
Access_token	Jeton d'accès GitHub	Oui	Vous pouvez simplement passer `${{secrets.GITHUB_TOKEN}}`
Img_width	Largeur de l'img	Non	`100`
FONT_SIZE	Taille de la police du nom (PX)	Non	`14`
CHEMIN	Chemin vers le fichier que vous souhaitez ajouter la liste des contributeurs	Non	`/README.md`
BIFURQUER	La branche pour mettre à jour le fichier spécifié dans le chemin	Non	`''` Ce qui signifie la branche par défaut
Pull_request	Ouvrez une nouvelle demande de traction si elle est définie sur un nom de branche cible	Non	`''` Ce qui signifie ne pas ouvrir la demande de traction par défaut
Commit_message	commettre un message	Non	`docs(README): update contributors`
Avatar_shape	Placer `round` pour l'avatar rond et `square` pour un avatar carré	Non	carré
Ignored_Contributeurs	Contributeurs ignorés, séparés par la virgule	Non	`''`

Remarque: vous devez laisser une ligne vide après la ligne CONTRIBUTOR pour la première fois
Remarque: GitHub semble ne pas prendre en charge le style d'image dans le rendu du fichier de marque
Remarque: IGNORED_CONTRIBUTORS prend le nom d'affichage pas le nom d'utilisateur
Remarque: PULL_REQUEST doit être utilisé avec BRANCH ensemble, les deux doivent être fournis si vous souhaitez ouvrir une demande de traction

Maintienneur

@Bobankh

Comment contribuer

Vous devez suivre notre code de conduite.

Voir les directives contributives pour les conventions contributives.

Assurez-vous de passer tous les tests avant de soumettre votre code. Vous pouvez effectuer pytest -ra au répertoire racine pour exécuter tous les tests.

Vous pouvez utiliser le mode local lors de la mesure sur votre machine locale, voici les informations d'aide en ligne de commande:

 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