Especificação
Um exemplo de como usando a tabela de especificação todos os colaboradores pode reconhecer todos os contribuintes
Obrigatório
Para apoiar a especificação de todos os colaboradores, projetos de código aberto devem incluir os seguintes itens obrigatórios:
- Uma seção de "Colaboradores" em um local de destaque da documentação do repositório do projeto que inclui uma lista de todos os colaboradores do projeto
- O objetivo deve ser a utilização do site mais proeminente de documentação do projeto, quando for possível. Em muitos casos, este é o arquivo README do projeto
- Quando a quantidade de colaboradores em um projeto for grande, considere usar o arquivo CONTRIBUTORS na raiz do repositório, em vez de usar o arquivo README para reconhecer contribuições. Neste caso, um link proeminente para o arquivo de contribuintes deve ser incluído na página README sob o título "Colaboradores"
- As listagens devem ser formatadas como uma tabela com as seguintes informações sobre os colaboradores do projeto:
- Nome
- A URL cria uma referência para um site em que mais informações podem ser obtidas sobre o contribuidor. Essa URL pode ser determinada pelo contribuidor a critério do projeto.
- Pode-se indicar uma Categoria de Contribuição usando texto ou emoji pré-definidos (veja abaixo).
- Um link para a Categoria de Contribuição usando texto ou um emoji pré-definido.
- A lista de colaboradores pode ser difundida em várias linhas (cada uma tecnicamente com sua tabela) conforme necessário.
- A ordem dos contribuidores é irrelevante para a especificação. Ordene-os do jeito que quiser.
- Projetos devem considerar contribuidores como aqueles que contribuem para um projeto em qualquer uma das Categorias de Contribuição, qualquer que seja o nível de contribuição. Esta especificação inclusive é, por definição, de todos os seus contribuidores. Em casos em que os projetos se desviam das Categorias de Contribuição ou requerem um nível específico de contribuição para atender aos critérios como colaborador do projeto, o projeto deve fornecer uma documentação explícita das definições que satisfazem os critérios do contribuidor do projeto no documento CONTRIBUTING ou um documento público de destaque semelhante no nível superior do repositório do projeto. Essa especificação é contra a exclusão de um indivíduo da lista de Contribuidores baseada no nível percebido de contribuição. Em vez disso, projetos devem usar indicadores de esforço dentro da lista de seus contribuidores. Caso sejam usados, esses indicadores de esforço ficam a critério do projeto e atualmente não são especificados.
Dica de profissional: Você pode usar o bot @all-contributors 🤖 para automatizar o reconhecimento dos contribuidores de seus projetos de código aberto ✨
Opcional
Os projetos devem considerar os seguintes itens opcionais como parte de seu comprometimento para a especificação Todos os Contribuidores:
- A inclusão do avatar do usuário é recomendada.
- Um link opcional no indicador da Categoria de Contribuição pode ser incluído para prover informação adicional sobre suas contribuições. Isso é explicado na seção abaixo.