Navigation Menu

Skip to content

Instantly share code, notes, and snippets.

@KathyReid
Last active March 31, 2018 01:06
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save KathyReid/a69afe10161fdb1b1002799542d236e2 to your computer and use it in GitHub Desktop.
Save KathyReid/a69afe10161fdb1b1002799542d236e2 to your computer and use it in GitHub Desktop.
Skill Review Template

Review of skill-subsonic-media

Standard checks (non-code checks)

  • Check name of Skill skill-subsonic-media is unlikely to conflict with other vocal install Skill X commands = there are no similar phonemes for subsonic, but several for media. This Skill would still be the only one picked up on an install subsonic Utterance => I'm OK with it
  • Check dialog - from a voice user interface perspective the dialog works well. I ran the .dialog through mimic (https://mycroft.ai/documentation/mimic/) and would like to recommend changing Playing the requested media from Subsonic to Now playing the requested media from sub sonic - the 'now playing' is more in line with other dialogs, and the space in between sub and sonic means that Mimic adds a slight pause which makes the TTS just slightly nicer.
  • Check vocab - the play Intent, even though it uses fuzzywuzzy matching, is likely to conflict with other play Intents if the user has multiple playback Skills. This is part of a broader issue where we have Skills with overlapping Intents - I don't think it makes sense to hold up this Skill being accepted, but it's something we should be aware of.
  • Check regex - Skill does not use regex Intent matching, not checking
  • Check README for completeness - This README gives me pure joy. It is one of the most complete READMEs we have for a Skill. Recommend minor wording change - enter subsonic details under .. looks like it's missing some words.
  • Check requirements.txt - no issues I can see
  • Check settingsmeta.son - well structured, excellent placeholder text
  • Check __init__.py - I'm not fluent with Python yet, so couldn't see any obvious Py issues.

Now requesting Python code review from Skills Team.

@penrods
Copy link

penrods commented Mar 31, 2018

NOTES:

  • Check name of skill.
    It is OK to have conflict/duplication of names. The verbal install now will ask if there is ambiguity. But definitlely something to think about.
    Also verify verbal prononcability by saying it in the command line several times and reading transcriptions.

  • Check dialog
    Good. Sometimes words don't render as expected and alternative vocabulary should be used. I always play EVERY phrase on the CLI using: say Playing the requested media from Subsonic

  • Check vocab
    Good. Autotests will assist in this (instructions coming soon from dev team)

  • Check regex
    Ditto

  • Check README.md
    NOTE: We can add more hints to the template editor. E.g. "Don't use the phrase 'This skill...' in the one line description"

  • Check requirements.txt

  • Check __init__.py
    Autotests will assist in this (instructions coming soon from dev team). If these have issues, they will fail.

  • Check settingsmeta.son
    Minor typo ('.json' not '.son').

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment