Inline Notifications Guidance

Inline Notification Guidance

Always use squash and merge.
An inline notification will show if the update is made within the past 30 days.
- For new users or users in incognito mode, updates in the past 30 days will always show. ** For returning users, visitation tracking will track if the user has visited the page in the past 30. days. If the user has not visited the page since the notification appeared, show the notification. If user has already seen the update, the notification will not show.
If multiple updates were made within the past 30 days to the same component, only the most recent update will show.

When sending out an update, enter the notification you would like to notify the users at the bottom of the description for the PR in the Notifications section. Write the notifications in the following format:

[Update/New tag]Exact name of component/template

[name of the updated section within the guidance][Another update section]

Message to fill the inline notification

there is an empty line between #### Notifications, the component name, name of updated sections and the message.
The component name is not case sensitive, however it must match the name on Design Systems website.
This notifications pattern can continue indefinitely to enter updates to multiple components.
Updates to different sections of the same component should be written as one message.
You can report updates to multiple sections by listing out the section names with no spaces between the brackets.
- Similar to component name, keep the section name exactly same as the design systems site reports.
Only write one message per tag. This messages needs to include all updates for that component. Try to limit it to 180 characters.
Write message continuously from one line, do not hit ‘return” to start a new paragraph.
For New components/templates, leave the sections and description as empty brackets.