Manual Approvals Playbook

Goals

• Provide a min-bar for models submitted to the public PR repo
• Allow model consumers to find device details

PR review process

• Once all validation checks succeed
• Check if the PR requires to sync the base branch (some customers give permissions to maintainers, if not mark the PR as changes requested)
• Check if the dtmi translates to an existing folder (aka namespace)
• PRs requesting a new namespace must fill the PR templates with Company Name, Device details, etc..
• PRs adding models to an existing namespace must be approved by the original submitter

Models Review hints

• JSON must be well formatted with tabs or spaces (no single line json)
• The root interface SHOULD include a displayName, ask the user if the missing field is intentional
• The displayName should include the en language
• When using a non-default language, it must be preserved in the same interface
• Check for spelling/grammar errors in displayName, description and comments fields
• Check for opportunities to use Semantic types in Telemetry and Properties
• Check for opportunities to use schemas to avoid duplication
• Check if the central context is needed
• Models using advanced features such as extends or custom semantic types, must be validated in Central by importing manually
• Suggest to follow the DTDL Naming Guidelines

Review Times

• PRs will be reviewed within a 3 business days
• PRs in Changes Requested state will be closed if there is no activity in 15 days