All Contributors

All Contributors

  • Docs
  • GitHub
  • Languages iconPortuguês (Brasil)
    • English
    • 日本語
    • Deutsch
    • Español
    • Français
    • Bahasa Indonesia
    • 한국어
    • Polski
    • Русский
    • 中文

›@all-contributors bot 🤖

Especificação

  • Visão geral
  • Especificação
  • Tabela de Emoji ✨
  • Mantenedores de Repositório
  • Ferramentas

@all-contributors bot 🤖

  • Visão geral
  • Instalação
  • Utilização
  • Configuração
  • FAQs

CLI

  • Visão geral
  • Instalação
  • Utilização
  • Configuração

Projeto

  • Ajude a melhorar
  • Código de Conduta
  • Quem está usando?
Edit

Instalação do Bot

1. Instale o AllContributors GitHub App

Instale o App GitHub

Captura de tela da instalação do aplicativo

2. Configure seus repositórios

Captura de tela da configuração dos Repositórios

3. Criar um README.md

Certifique-se que você tem o arquivo README.md na raiz do projeto (ele pode estar vazio).

Se você prefere a sua tabela de contribuintes em um lugar que não seja o README.md; Após a fusão o seu bot primeiro PR, você pode mover o seu quadro de colaboradores, ver arquivos na configuração do bot

Certifique-se de adicionar o seguinte trecho:

Para a lista:

## Contributors

<!-- ALL-CONTRIBUTORS-LIST:START - Não remova ou modifique esta linha -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->

Nota: Essa linha extra é muito importante para que funcione corretamente.

Substitua projectOwner pelo nome do usuário administrador ou organização no GitHub, e projectName pelo nome do repositório. O estilo, a cor e outros parâmetros podem ser personalizados ao seu gosto - veja https://shields.io/.

[![All Contributors](https://img.shields.io/github/all-contributors/projectOwner/projectName?color=ee8449&style=flat-square)](#contributors)

Please create the .all-contributorsrc file for the first configuration. It can only have the mandatory information in it to begin. The bot will update it automatically with default config in the first PR. Here is the minimal .all-contributorsrc file to add in your repo :

{
  "projectName": "<insert the repo's name>",
  "projectOwner": "<insert the repo's owner/orgs>"
}

4. Atualizar sua documentação sobre contribuição

Considere atualizar seu CONTRIBUTING.md ou similar com passos sobre como contribuintes podem adicionar-se. Você ainda pode ligar para o bot uso documentação.

O que vem a seguir

  • Utilizando o Bot
  • Configurando o Bot
← Visão geralUtilização →
  • 1. Instale o AllContributors GitHub App
  • 2. Configure seus repositórios
  • 3. Criar um README.md
  • 4. Atualizar sua documentação sobre contribuição
  • O que vem a seguir
All Contributors