Skip to content

Checklist: Template Verification

sibille edited this page Nov 15, 2018 · 1 revision
  1. Automated tests: Verify the template is included in the following tests:

    • Build Tests
      • BuildEmptyProjectAsync
      • BuildAllPagesAndFeaturesAsync
      • BuildAllPagesAndFeaturesRandomNamesCSAsync
      • BuildEmptyProjectWithAllRightClickItemsAsync
      • BuildCompleteProjectWithAllRightClickItemsAsync
      • GenerateAllPagesAndFeaturesAndCheckWithStyleCopAsync
      • Build[Framework]OneByOneItemsAsync
      • BuildEmptyLegacyProjectWithAllRightClickItemsAsync
    • Encoding Tests
      • EnsureAllTemplateFilesAreEncodedCorrectly
    • CodeStyle Tests
      • EnsureCSharpCodeDoesNotUseThis
      • EnsureTemplatesDoNotUseTabsInWhitespace
    • TemplateVerification Tests
      • VerifyAllTemplateFilesAsync
      • VerifyTemplateFolderContentsAsync
  2. Generated Code

    • Code review
    • Templates with UI -> Get a review from design team [when in doubt, ping @crutkas]
    • Feature team of API sign-off [when in doubt, ping @crutkas]
    • Accessibility: Review accessibility checklist
    • Localization Ready: Review all texts and error messages in code are retrieved from a localizable resource (Resources.resw)
    • Comments & "WTS TODO"s
      • Review comments are relevant and understandable
      • Has link to official documentation
      • Spelling & grammar check
  3. Templates

    • TemplateValidator tests pass
      • Unique identity
      • Dependency identities
      • Verify Primary Output
      • Verify composition filters
    • Evaluate and balance among
      • Code duplication in templates
      • Use of composition templates
    • Licenses: Review nuget packages
    • Icon: Template is not showing the default icon
    • Description (Summary and Details)
      • Spelling & grammar check
      • Localization
    • Framework/ProjectTypes: Icon/Description in _catalog
    • Review use of reservedNames in Template
    • Review the templates sourceName is used in replacements