add contributors Descargar - add contributors Descargar

add contributors

Otro código fuente

v0.2.2

Descargar

Agregar contribuyentes

Una acción de GitHub para agregar contribuyentes a su archivo Markdown (es decir, readme.md) automáticamente en el horario o activado por eventos

Manejar específicamente el contexto chino inalcanzable (着重解决了中文内容乱码的问题)

No dude en enviar una solicitud de extracción o un problema, pero asegúrese de seguir las plantillas

¡Bienvenidos contribuyentes para mejorar este proyecto juntos!

Uso

Cree un archivo de flujo de trabajo como .github/workflows/contributors.yml (puede encontrarlo en este repositorio)

 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 '

Parámetros

Parámetro	Descripción	Requerido	Por defecto
Repo_name	Nombre de repositorio	No	`''` Lo que significa repositorio actual
CONTRIBUYENTE	Donde quieres agregar la lista de contribuyentes	No	`### Contributors`
Column_per_row	Número de contribuyentes por fila	No	`6`
Access_Token	Token de acceso de Github	Sí	Solo puede pasar `${{secrets.GITHUB_TOKEN}}`
Img_width	Ancho de IMG	No	`100`
Font_size	Tamaño de la fuente de nombre (PX)	No	`14`
CAMINO	Ruta al archivo que desea agregar la lista de contribuyentes	No	`/README.md`
RAMA	La rama para actualizar el archivo especificado en la ruta	No	`''` Lo que significa rama predeterminada
Pull_request	Abra una nueva solicitud de extracción si se establece en un nombre de rama de destino	No	`''` Lo que significa que no abre la solicitud de extracción por defecto
Commit_message	Mensaje de compromiso	No	`docs(README): update contributors`
Avatar_shape	`round` para avatar redondo y `square` para avatar cuadrado	No	cuadrado
Ignored_Contributores	Contribuyentes ignorados, separados por coma	No	`''`

Nota: debe dejar una línea en blanco después de la línea CONTRIBUTOR por primera vez
Nota: GitHub parece que aún no admite el estilo de imagen en la representación del archivo de Markdown todavía
Nota: IGNORED_CONTRIBUTORS toma el nombre de la pantalla, no nombre de usuario
Nota: PULL_REQUEST debe usarse con BRANCH juntos, ambos deben proporcionarse si desea abrir una solicitud de extracción

Mantenedor

@Bobankh

Cómo contribuir

Debe seguir nuestro código de conducta.

Ver pautas contribuyentes para las convenciones contribuyentes.

Asegúrese de pasar todas las pruebas antes de enviar su código. Puede realizar pytest -ra en el directorio raíz para ejecutar todas las pruebas.

Puede usar el modo local cuando lo desarrolle en su máquina local, aquí está la información de ayuda de la línea de comandos:

 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