The optional keys of the saved --prs JSON are not documented

Aperta Adatta ai principianti
#1,339 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
82/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
python
Ambito
documentation

Direzione di ricerca

Inizia dalla docstring del modulo e da --help in scripts/check_contributors.py, poi aggiorna la riga --prs in CONTRIBUTING.md. Documenta i tipi e gli usi di commit_authors, closing_issues e files con un esempio JSON. Aggiungi o aggiorna un test per analizzare l’esempio tramite --pending e --stub; il lavoro è concluso quando il test passa e tutte e tre le chiavi sono documentate.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

community documentation good first issue

Where: scripts/check_contributors.py (module docstring and --help), CONTRIBUTING.md.

Current gap: --prs FILE is documented as gh pr list --state merged --json number,author,mergedAt,title,body, but the stub and pending code also read commit_authors, closing_issues and files per PR (set from gh pr view when the data comes from GitHub), so someone preparing an offline file or a test fixture has to read the source to know.

Suggested approach: List the optional keys, their types and what uses them in the docstring and the CONTRIBUTING row, with one JSON example.

Done when: the three keys are documented and a test parses the documented example through --pending and --stub.

Lingua principale
HTML
Stelle
47
Fork
45
Merge medio
2h 39m
PR unite (30g)
57

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di yakew7/Fair-Code

Tutte le issue di yakew7/Fair-Code

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.