Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Improve in-code documentation

Aperta
#175 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
20/100
Tipo di issue
Documentazione
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
python
Ambito
documentation

Direzione di ricerca

Inizia esaminando la codebase Python alla ricerca di pydocs mancanti e verificando le PRs proposte menzionate nella issue. L’ambito comprende la documentazione e gli esempi in quasi tutto il codice, oltre a una policy per prevenire PRs non documentate. Per considerarlo completato sarebbero necessari un approccio condiviso e un’ampia copertura della documentazione mancante.

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

Descrizione

enhancement

Almost all code now lacks proper pydocs across almost all the codebase. We should consider the following PRs are gonna improve the situation.

It should be prohibited to merge PRs that do not have docs. We should eventually cover all the missing places with appropriate documentation and examples.

Lingua principale
Python
Stelle
342
Fork
65
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Apri la guida per i contributori

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 cloudevents/sdk-python

Tutte le issue di cloudevents/sdk-python

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.