|COMMON FAIL POINTS ARE HIGHLIGHTED|
Updated November 2019. I will do my best to update this once a month.
|Documentation Deployment Checklist:|
|version||CAN'T SUBMIT||Must increment for every public submission.|
|store-sections - must have a store section||FAIL||1 most relevant store section. Can be in 2 store sections if justified.|
Capsule Info file. Usually found in resources/en-US. You might need to create your own if it's not in your project directory.
|display-name - must be defined||FAIL||What your capsule displays as in the Marketplace.|
|display-name - can't include "test", "beta", "dev", etc.||FAIL||"trivia genie test" will be a fail||https://bixbydevelopers.com/dev/docs/reference/type/capsule-info.dispatch-name|
|developer-name - must be defined||FAIL||What your capsule displays as your developer name in the Marketplace.||https://bixbydevelopers.com/dev/docs/reference/type/capsule-info.developer-name|
|icon-asset - must be defined||FAIL||Must be .png format and 1:1 ratio. Don't use Bixby logo or other major brands without consent||https://bixbydevelopers.com/dev/docs/reference/type/capsule-info.icon-asset|
|description - must be defined||FAIL||Must accurately describe what your capsule does.||https://bixbydevelopers.com/dev/docs/reference/type/capsule-info.description|
|dispatch-name - must be defined||FAIL||At least two words or a compound word. Words like "The" do not count.||https://bixbydevelopers.com/dev/docs/reference/type/capsule-info.dispatch-name|
|dispatch-name - must work with ASR||FAIL|
Try speaking your dispatch name into the simulator / on-device testing. Bixby must be able to pick it up
|dispatch-name - can't be too generic||FAIL||Something like "trivia game" is too generic but "trivia genie" is fine||https://bixbydevelopers.com/dev/docs/reference/type/capsule-info.dispatch-name|
|dispatch-name - must be unique||FAIL||Search the Marketplace for your dispatch name||https://bixbydevelopers.com/dev/docs/reference/type/capsule-info.dispatch-name|
dispatch-name - must be nearly identical to display-name
|dispatch-name - avoid using homophones||FAIL/WARNING||ASR issues.||https://www.rhymezone.com/|
|dispatch-aliases - Follows all dispatch-name rules||FAIL||Many capsules fail in the review process here. Use only if you think you need them.||https://bixbydevelopers.com/dev/docs/reference/type/capsule-info.dispatch-aliases|
|dispatch-aliases - Limited use cases||FAIL|
Mainly for adding/removing the word "the", plural variations, and combining/splitting compound words.
|dispatch-aliases - No synonyms||FAIL||Don't use dispatch-aliases to replace words with synonyms.||https://bixbydevelopers.com/dev/docs/reference/type/capsule-info.dispatch-aliases|
|dispatch-aliases - Not to be used to fix ASR issues||FAIL||If you're having ASR issues, the variation is usually too huge for dispatch aliases to account for.||https://bixbydevelopers.com/dev/docs/reference/type/capsule-info.dispatch-aliases|
|website-url - must be valid link and relevant||FAIL||If included, must link to valid and relevant url.||https://bixbydevelopers.com/dev/docs/reference/type/capsule-info.website-url|
|terms-url - must be valid link and relevant||FAIL||If included, must link to valid and relevant url.||https://bixbydevelopers.com/dev/docs/reference/type/capsule-info.terms-url|
|privacy-policy-url - must be valid link and relevant||FAIL|
If included, must link to valid and relevant url. Needed for user-profile-access. Might be required in the future.
|search-keywords - must be relevant||WARNING||Recommended to have some relevant search keywords. 10 max. No "Apple", "Google", "Samsung"||https://bixbydevelopers.com/dev/docs/reference/type/capsule-info.search-keywords|
Hints file. Usually found in resources/en-US. You might need to create your own if it's not in your project directory.
|hints - At least 3. Must be properly formatted||FAIL||All 3 hints are top level utterances and MUST WORK!|
|hints - work with ASR (AKA voice)||FAIL||MUST WORK WITH VOICE! The user can say the entire hint and ASR should be able to pick it up.|
|hints - Hint variations must work||FAIL||Test variations of hints with voice. Improper error handling will fail your capsule. Watch Video 3|
|hints - Error handling||FAIL||If errors happen (usually in the variations), handle them correctly! See 3rd video for examples.||https://bixbydevelopers.com/dev/docs/sample-capsules/samples/error-handling|
|hints - No spelling or grammar mistakes||FAIL|
UI/UX can fail your capsule! Please make sure you don't violate any of the following rules.
|Dialog/Persona - don't be another persona/assistant||FAIL||Don't introduce your capsule as Siri, Bob, Jimmy, Lizzy, etc, or any other assistant||https://bixbydevelopers.com/dev/docs/reference/type/dialog|
|Dialog - don't repeat dialog in the view||FAIL||Unless you have a good reason, don't repeat the dialog up top in the view below.||https://bixbydevelopers.com/dev/docs/reference/type/dialog|
|Dialog - must read text in the dialog||FAIL||Don't put text in the dialog area and have Bixby not read it.||https://bixbydevelopers.com/dev/docs/reference/type/dialog|
Dialog - Put short dialogs in dialog. Long dialogs in views.
|FAIL||Around 400 characters or so, you should put the dialog in the view.||https://bixbydevelopers.com/dev/docs/reference/type/dialog|
|Dialog - Don't use defaults like "Here's what I found"||FAIL/WARNING||Depending on the situation, you can use the default "Here's what I found". To be safe, don't use it.||https://bixbydevelopers.com/dev/docs/reference/type/dialog|
|Tappable Components - must be tappable||FAIL||If the component has a lightbox and on-click option, it needs to do something on tap.||https://bixbydevelopers.com/dev/docs/reference/type/layout.content.section.content|
|Punchout Links - use the correct component||FAIL||Use an attribution link. Don't use other tappable components to punch out.||https://bixbydevelopers.com/dev/docs/reference/type/layout-macro-def.content.attribution-link|
List Views, Input Views, and Prompts - must allow voice
|FAIL||Use use-input-views-for-selection-list-detail for list views. Train for input views.|
Misc. Here's more stuff that could fail your capsule or just be issued a warning. Most of these are more niche / optional compared to the above! Any of the WARNINGS can result in a fail at our disgression.
|Performance - Capsule is not too slow||FAIL/WARNING||2-3 seconds a response is fine. 6+ is too slow. We may reject if it is too slow.|
Loading - Variable names should not be exposed to user
|WARNING||"Looking for VARIABLE...". Use progress dialogs.||https://bixbydevelopers.com/dev/docs/reference/ref-topics/dialog-modes.dialog-events#progress-event|
|Spelling and Grammar||FAIL/WARNING||Bad spelling and grammar could get your capsule rejected. Usually it's just a warning.|
|Capsule Scope - tightly focused||FAIL||Stay in your capsule's lane. For example, "Movie Finder" capsule should not give dinner recipes|
Conversation Drivers - not too many, not too long, functional
|FAIL||Should not be more than 3-5 words. Don't have too many in a single view (4+). Must work.||https://bixbydevelopers.com/dev/docs/reference/type/result-view.conversation-drivers|
user-profile-access - Don't also use guest-access-allowed
|FAIL||If you use user-profile-access, don't use guest-access-allowed. Violation of privacy laws.|
|Sample Code - can't be too similar to a sample code||FAIL|
Don't just copy and paste a template capsule and submit it. At least put some original content in them!
Facts Template and other Tempaltes - Minimum quantity
At least 10 facts/jokes with images or 20 facts/jokes without images. At least 10 questions in a quiz template.
|Submit your capsule!||IN REVIEW||Make a public submission in the IDE. Open browser and go to your capsule and submit it for review.|
Bixby Capsule Approval Process: Part 1 - How to get your Bixby Capsule into the Marketplace
Bixby Capsule Approval Process: Part 2 - Frequent Rejections - Dispatch Names and Dispatch Aliases
Bixby Capsule Approval Process: Part 3 - Frequent Rejections - Hints and Testing ASR
Bixby Capsule Approval Process: Part 4 - Frequent Rejections - UI/UX