Skip to content

Commit 925c824

Browse files
authored
fix(AIP-140): add abbreviations field name guidance (#1465)
1 parent af6d478 commit 925c824

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

aip/general/0140.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,19 @@ preposition must be present to accurately convey the unit. Additionally, "per"
8383
is often appropriate in reporting scenarios (e.g. "nodes per instance" or
8484
"failures per hour").
8585

86+
### Abbreviations
87+
88+
For well known name abbreviations among software developers, such as "config"
89+
and "spec", the abbreviations **should** be used in API definitions instead of
90+
the full spelling. This will make the source code easy to read and write.
91+
Examples:
92+
93+
- `config` (**not** `configuration`)
94+
- `id` (**not** `identifier`)
95+
- `info` (**not** `information`)
96+
- `spec` (**not** `specification`)
97+
- `stats` (**not** `statistics`)
98+
8699
### Adjectives
87100

88101
For uniformity, field names that contain both a noun and an adjective
@@ -162,6 +175,7 @@ field **should not** have a uniqueness requirement.
162175

163176
## Changelog
164177

178+
- **2024-12-20**: Copy over abbreviations guidance from old design site.
165179
- **2024-08-26**: Codify exception to string and base64 guidance
166180
- **2024-05-18**: Documented the effect of field names on client surfaces.
167181
- **2023-04-25**: Field names **must not** be expressed as verbs.

0 commit comments

Comments
 (0)