all-contributors / all-contributors/allcontributors.org

Improve example structure in README for contributor types

Offen
#967 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
enhancement
Vorherrschende Sprache
MDX
Sterne
8.1k
Forks
1.7k
Ø Merge
17 Std. 1 Min.
Gemergte PRs (30 T.)
6

Beschreibung

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!

Beitragsleitfaden

Beitragsleitfaden öffnen

Bewertung

Dieses Issue wurde noch nicht bewertet.

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.