InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns
Acknowledging all contributions/contributors
Ninguém assumiu esta issue ainda.
- Linguagem predominante
- HTML
- Estrelas
- 853
- Forks
- 206
- Merge médio
- 1d 23h
- PRs com merge (30d)
- 2
Descrição
GitHub has a way to show the people that committed (code) to this project. However by default only very few people are shown, and there is no further information about what they have contributed either.
As our community grows, it would be great to acknowledge the broad range of people that are supporting our patterns in all sorts of ways, not just the ones contributing code/patterns.
Implementation thoughts
I have heard good things about the all-contributors spec and bot but I don't know how it works in practice.
Their claim is:
Recognize All Contributors - Including those that don't push code
However their documentation looks like users need a GitHub handle to be added as contributors, which seems counter intuitive.
I am taking inspiration from The Turing Way project, who are using the tool for years.
We could review their implementation notes. Some links to get started:
- https://github.com/alan-turing-institute/the-turing-way/blob/main/contributors.md#record-of-contributions
- https://github.com/alan-turing-institute/the-turing-way/blob/main/CONTRIBUTING.md#recognising-contributions
- https://github.com/alan-turing-institute/the-turing-way/issues/274
- https://github.com/alan-turing-institute/the-turing-way/issues/446
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Direção de pesquisa
Leia as seções vinculadas de contributors.md e CONTRIBUTING.md do Turing Way e, em seguida, analise a especificação do all-contributors e a documentação do bot. Determine como este projeto deve representar contribuições de código e contribuições que não sejam de código, incluindo contribuidores sem identificadores do GitHub. O trabalho estará concluído quando a abordagem de reconhecimento escolhida e seu processo de manutenção estiverem acordados e documentados.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- github
- Domínio
- documentation
- Tipo de issue
- Funcionalidade
- Dificuldade
- 5/5
- Tempo estimado
- Mais de uma semana
- Status de atividade
- Estagnada
- Clareza
- Precisa de esclarecimento
- Facilidade para iniciantes
- 25/100