Skip to main content

Code reviews rule: Missing app descriptions

Written by David Martin

Missing app descriptions

Why is this an issue?

An app's description is shown to users in the App Launcher, next to the app's name and icon, so it is one of the few metadata descriptions your end users read directly. Descriptions help users:

  • Pick the right app from the App Launcher

  • Tell similar apps apart in an org that has accumulated many

Examples

Example of incorrect metadata:

<CustomApplication>
<label>Order Management</label>
<uiType>Lightning</uiType>
</CustomApplication>

Example of correct metadata:

<CustomApplication>
<description>Used by the fulfillment team to work orders end to end. Owned by the Operations group.</description>
<label>Order Management</label>
<uiType>Lightning</uiType>
</CustomApplication>

How can I fix violations?

Add a description saying who the app is for and what they use it to do. In Setup:

  1. Go to App Manager

  2. Click the app's row and select Edit

  3. Fill in the Description field on the App Details & Branding page

  4. Click Save

The description appears in the App Launcher, so write it for the people who will pick the app from that list.

When should I disable this rule?

You may dismiss specific violations for apps kept only for testing or migration.

Resources

Did this answer your question?