Consistent naming for enterprise & organization scoped functions
- Vorherrschende Sprache
- Go
- Sterne
- 11.3k
- Forks
- 2.5k
- Ø Merge
- 1 T. 20 Std.
- Gemergte PRs (30 T.)
- 53
Beschreibung
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`.
Beitragsleitfaden
Rechercherichtung
Beginne damit, die im Issue besprochenen Funktionen mit Enterprise- und Organisations-Scope zu inventarisieren und ihre aktuellen Benennungsmuster zu überprüfen. Lege die Konventionen für gültige Scopes und Subjects fest, bevor du Namen änderst, und überprüfe anschließend, dass die resultierende API über alle betroffenen Funktionen hinweg konsistent angewendet wird.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- go
- Bereich
- api
- Issue-Typ
- Refactoring
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 25/100