Add guidelines to prefer "flat" over "nested" structures

Aperta
#541 3 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

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

Direzione di ricerca

Inizia individuando le sezioni esistenti delle linee guida API che trattano le strutture annidate e rivedi gli esempi circostanti. Aggiungi indicazioni che favoriscano le strutture piatte, inclusi esempi di quando l'annidamento aggiunge valore e di quando non lo fa; il lavoro è completato quando le indicazioni sono integrate in modo coerente nel documento esistente.

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

Descrizione

Azure Guidelines

Nesting complicates the user experience and should only be used when necessary. We should add guidance to use flat structures unless there is some significant value to nesting, with some specific examples where nesting does add value and where it does not.

Lingua principale
Nessun dato sulla lingua
Stelle
23.3k
Fork
2.7k
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 microsoft/api-guidelines

Tutte le issue di microsoft/api-guidelines

Issue simili

Altre issue su Backend & API Design

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.