all-contributors / all-contributors/allcontributors.org

Improve example structure in README for contributor types

Aberta
#967 0 comentários 0 reações 0 responsáveis Ver no GitHub
enhancement
Linguagem predominante
MDX
Estrelas
8.1k
Forks
1.7k
Merge médio
17h 1min
PRs com merge (30d)
6

Descrição

Hi there! 👋
I’m exploring the project and really like the idea of recognising all kinds of contributions. I noticed that while the README describes contribution types, there isn’t a clear **example table** showing how to use them in practice.

### Issue
The documentation mentions multiple contribution types (e.g., code, doc, design) but lacks a concrete example of how to list a contributor with all the types they engaged in.

### Expected
- A sample contributor table row with multiple types included (e.g., “@username – code, doc, test”)
- A short description of what each type covers
- Guidance on where to add this in the README or contributing guide

### Actual
The README has the types listed but no explicit example showing how to format them in the contributors table.

### Suggestion
Add a subsection in the README (or a “Examples” section) with at least one full example row showing usage of multiple contribution types. This will make onboarding new contributors smoother.
Thanks for the great work!

Guia de contribuição

Abrir o guia de contribuição

Avaliação

Esta issue ainda não foi avaliada.

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.