Adhere to Go naming conventions and maintain consistency with established codebase terminology. This includes proper capitalization of acronyms (e.g., "OCI" not "Oci"), avoiding underscores in identifiers, following standard library naming patterns, and using consistent terminology throughout the codebase.
Adhere to Go naming conventions and maintain consistency with established codebase terminology. This includes proper capitalization of acronyms (e.g., “OCI” not “Oci”), avoiding underscores in identifiers, following standard library naming patterns, and using consistent terminology throughout the codebase.
Key guidelines:
GetOCICreds()
not GetOciCreds()
unmarshalYamlFile
not unMarshalYamlFile
(consistent with json.Unmarshal
)APIVersion
over groupVersion
when it aligns with backend terminology_seconds
suffixExample:
// Good - follows Go conventions
func (repo *Repository) GetOCICreds() oci.Creds {
// implementation
}
// Bad - incorrect acronym capitalization
func (repo *Repository) GetOciCreds() oci.Creds {
// implementation
}
Consistent naming reduces cognitive load, improves code readability, and aligns with community expectations and tooling requirements.
Enter the URL of a public GitHub repository