add contributors

add-contributores

Uma ação do GitHub para adicionar colaboradores ao seu arquivo de marcação (ou seja, readme.md) automaticamente dentro do cronograma ou desencadeado por eventos

Lidar especificamente ao contexto chinês inacessível (着重解决了中文内容乱码的问题)

Sinta -se à vontade para enviar uma solicitação de tração ou um problema, mas siga os modelos

Bem -vindo colaboradores para melhorar este projeto juntos!

Uso

Crie um arquivo de fluxo de trabalho como .github/workflows/contributors.yml (você pode encontrá -lo neste repositório)

 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	Descrição	Obrigatório	Padrão
Repo_name	Nome do repositório	não	'' que significa repositório atual
CONTRIBUINTE	Onde você deseja adicionar lista de colaboradores	não	### Contributors
Column_Per_Row	Número de colaboradores por linha	não	6
Access_token	Token de acesso ao github	sim	Você pode simplesmente passar ${{secrets.GITHUB_TOKEN}}
Img_width	Largura de img	não	100
Font_size	Tamanho da fonte do nome (px)	não	14
CAMINHO	Caminho para o arquivo que você deseja adicionar na lista dos colaboradores	não	/README.md
FILIAL	A filial para atualizar o arquivo especificado no caminho	não	'' que significa ramo padrão
Pull_request	Abra uma nova solicitação de tração se definida como um nome de ramificação de destino	não	'' , o que significa não abrir solicitação de puxar por padrão
Commit_message	cometer mensagem	não	docs(README): update contributors
Avatar_shape	Defina round para avatar redondo e square para avatar quadrado	não	quadrado
Ignorado_contributores	Contribuidores ignorados, separados por vírgula	não	''

Nota: você deve deixar uma linha em branco após a linha de CONTRIBUTOR pela primeira vez

Nota: o github parece não suportar o estilo de imagem na renderização de arquivos de marcação ainda

NOTA: IGNORED_CONTRIBUTORS recebe o nome de exibição , não nome de usuário

Nota: PULL_REQUEST deve ser usado juntos com BRANCH , ambos devem ser fornecidos se você quiser abrir uma solicitação de tração

Mantenedor

@Bobankh

Como contribuir

Você deve seguir nosso código de conduta.

Consulte Diretrizes contribuintes para convenções contribuintes.

Certifique -se de passar em todos os testes antes de enviar seu código. Você pode realizar pytest -ra no diretório raiz para executar todos os testes.

Você pode usar o modo local ao desenvolvê-lo em sua máquina local, aqui está as informações de ajuda da linha de comando:

 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

Colaboradores

Yixin Shen

Bailey Harrington

Casper

LICENÇA

Apache-2.0 © Bobankh