all-contributors / all-contributors/allcontributors.org

New format for `contributors` in config file

Aperta
#631 11 commenti 1 reazione 1 assegnatario Rivendicata da @tenshiAMD Vedi su GitHub
documentation enhancement good first issue pinned priority: high
Lingua principale
MDX
Stelle
8.1k
Fork
1.7k
Merge medio
17h 1m
PR unite (30g)
6

Descrizione

I'm proposing this new format for `contributors` in config file to include JSON `key` with value of `username`.

### Why:

- This will significantly reduce the iteration in fetching old contributions.

#### Proposed format

```json

"contributors": [
"tenshiAMD": {
"login": "tenshiAMD",
"name": "Angel Aviel Domaoan",
"avatar_url": "https://avatars.githubusercontent.com/u/13580338?v=4",
"profile": "https://tenshiamd.com/",
"contributions": [
"code",
"design",
"security",
"data",
"mentoring"
]
}
]

```

#### Old format

```json
"contributors": [
{
"login": "tenshiAMD",
"name": "Angel Aviel Domaoan",
"avatar_url": "https://avatars.githubusercontent.com/u/13580338?v=4",
"profile": "https://tenshiamd.com/",
"contributions": [
"code",
"design",
"security",
"data",
"mentoring"
]
}
]
```

Guida per i contributori

Apri la guida per i contributori

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.