Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extension guideline compliance #583

Open
5 of 10 tasks
jolampi opened this issue Feb 9, 2021 · 0 comments
Open
5 of 10 tasks

Extension guideline compliance #583

jolampi opened this issue Feb 9, 2021 · 0 comments

Comments

@jolampi
Copy link
Contributor

jolampi commented Feb 9, 2021

Since January 2021 version of VS Code there are now official guidelines for extensions: https://code.visualstudio.com/api/references/extension-guidelines

  • Notifications
    • Most of the notifications shown are as a result/feedback to user-initiated action.
    • Do not show options can only be added where applicable. Some actions directly respond to user.
    • Multiple notifications may be shown when notifying about new exercises.
    • "OK" buttons break the principle of no actions if there aren't any.
  • Progress notification
    • Show details link to display logs - how?
    • See if there are any applicable cases for providing a cancel option.
    • Add Timeout handling.
  • Views
    • Use (existing) icons with views.
    • View container shouldn't be used to open a webview. This might inherently be in conflict with the extension's usage principles.
  • Webviews
    • Ensure that views follow accessibility guidance.
    • Shouldn't be opened with extension updates. Big updates like 2.0 may warrant one anyway.
    • Shouldn't be used to replace existing functionality such as welcome pages (?), settings (Use native settings menu #492 )
    • See if "onboarding" could be used to guide user with using the extension.
  • Status bar
    • Barely used, should be simply removed.
  • Quick picks
    • Seems to be OK. Guideline may give hints for decorations.
  • Editor actions
    • Shouldn't use custom colors.
    • Shouldn't have more than one icon - current two seems more useful though.
    • Should use standard icons, but makes sense to have TMC icons in a TMC workspace.
    • Should be able to hide.
  • Context menus
    • Should be fine but make sure.
  • Settings
  • Command palette
    • Should be fine but make sure.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant