Naming Conventions

TODO

Finish the naming conventions for the marked sections, and add any additional sections as needed.

Good naming conventions in software engineering are critical as they enhance readability and maintainability of the code. By adhering to a consistent set of rules for naming variables, functions, classes, and other entities, developers ensure that the code and configuration is self-explanatory, which is essential for team collaborations and future code revisions. Moreover, good naming practices reduce the learning curve for new team members and facilitate debugging and code analysis, ultimately leading to more robust and efficient software development.

Follow SFDX naming conventions as a baseline, except where otherwise noted.

  1. Custom Objects, Custom Metadata Types, and Custom Settings

  2. Custom Fields (Follow SFXD Conventions)

  3. Validation Rules (Follow SFXD Conventions)

  4. Workflow Rules (Follow SFXD Conventions) ⚠️ DEPRECATED

  5. Custom Permissions

  6. Profiles

  7. Permission Sets and Permission Set Groups

  8. Flows (Follow SFXD Conventions)

  9. Named Credentials

All requirement keywords in these naming conventions use the terminology defined in RFC 2119 extended by RFC 6919.

Custom Objects, Custom Metadata Types, and Custom Settings

  1. All API names MUST be written in English, even when the label is in another language.

  2. All API names MUST be written in PascalCase.

  3. Objects SHOULD NOT contain an underscore in the objects name, except where explicitly defined otherwise in these conventions.

  4. Objects generally MUST (but you probably won't) contain a description.

  5. In all cases where the entire purpose of the object is not evident by reading the name, the object MUST contain a description.

  6. Junction object API names MUST be singular (not pluralized) and contain the API names of both objects.

Custom Permissions

  1. All Permission API names MUST be written in English, even when the label is in another language.

  2. All Permission API names MUST be written in PascalCase.

  3. Permissions SHOULD NOT contain an underscore in the API name, except where explicitly defined otherwise in these conventions.

Profiles

(to do)

Permission Sets and Permission Set Groups

(to do)

Named Credentials

(to do)

PreviousOpen StandardsNextBest Practices

Last updated

Was this helpful?