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

Document required/optional fields

Aperta
#10 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
35/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Ambito
documentation

Direzione di ricerca

Inizia esaminando i riferimenti esistenti nella documentazione a “auto generated” e “optional”, quindi fai un inventario dei campi dei metodi privi di un indicatore coerente. Definisci e applica un’unica convenzione per i campi obbligatori e opzionali nella documentazione dei metodi pertinenti, quindi verifica che ogni campo sia coperto.

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

Descrizione

The docs do mention things like "auto generated", "optional" at some places but why don't we clearly document all method fields with add tags like "required", "optional" or simply following some convention like adding asterisk* for required fields?

Lingua principale
JavaScript
Stelle
33
Fork
27
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

  • Nessun Dockerfile né file Docker Compose
  • Ha un modello di pull request
  • Nessuna 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 appbaseio/Docs

Tutte le issue di appbaseio/Docs

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.