google / google/go-github

Consistent naming for enterprise & organization scoped functions

Aperta
#3,761 1 commento 1 reazione 0 assegnatari Vedi su GitHub
Lingua principale
Go
Stelle
11.3k
Fork
2.5k
Merge medio
1g 20h
PR unite (30g)
52

Descrizione

I'd like to see a consistent naming convention used for enterprise and organization scoped functions that reflects the significance of the scoping. My suggestion is that we adopt the pattern `` which as a very simple example would look something like `GetOrganizationThing`. Scope and subject are an overlapping concept so we will need to define valid scopes that are linear (possibly just enterprise and organization). Subject is a more of an art than a science but we will still want to keep the most significant information at the beginning of the function name.

As an example of an alternative but supporting pattern; in a greenfield API design these scopes could have been structural with a pattern such as `client.organization.GetThing` instead of `client.GetOrganizationThing`.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia facendo un inventario delle funzioni con scope enterprise e organization discusse nell’issue e rivedendo gli attuali schemi di denominazione. Definisci le convenzioni valide per scope e subject prima di modificare i nomi, quindi verifica che l’API risultante sia applicata in modo coerente a tutte le funzioni interessate.

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

Valutazione

Stack tecnologico
go
Ambito
api
Tipo di issue
Refactoring
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.