Skip to content

Triaging Issues

Jump to bottom
IU edited this page Oct 18, 2020 · 7 revisions

Vetur receives a lot of issues. An ideal issue includes clear reproducible steps and is correctly labeled, so maintainers can easily tackle it. However, the issue tracker is seldom in that neat state.

If after reading this page you feel like helping out, please respond in https://github.com/vuejs/vetur/issues/2110.

Managing issues

First, see if the issue:

  • Is missing information 👉 need-more-info and ask for needed information.
  • Has no repro case 👉 no-repro-case and ask for a repro case. If there is demonstrated effort in providing information, keep it open for a few days. If author shows no effort (for example, just include a screenshot and a complaint), then close it right away.
  • Is a duplicate 👉 duplicate. Remove all other labels and refer to original issue in comment.
  • Is caused by upstream library 👉 upstream. Link the upstream issue and keep the issue open until the fix is available upstream and pulled in.
  • Is a question about usage 👉 question. Point to GitHub discussions.
  • Is out of the scope of Vetur 👉 invalid.
  • Is a bug 👉 bug.
  • Is a feature-request 👉 feature-request.
  • It is suitable for first time contributors to help 👉 good first issue.

Then, associate it with correct feature:

  • Programmatic Language Features: lsp/*.
  • Integration Issues: integ/*. Vetur integrates with a lot of other libraries, such as emmet, prettier and TypeScript. Use this label if the issue is caused by Vetur's usage of the library, for example, not passing the right prettier config or not having a features available in TS files.
  • Partially supported languages: lang/stylus, lang/pug and lang/sass. We might offer programmatic language features for them one day (we do for stylus), but we don't have enough bandwidth to implement language features for those languages from scratch.
  • One of those special areas, if it applies:
    • grammar, aka "syntax highlighting"
    • language-config: comment toggling, autoclosing, autosurrounding, indentation rules
    • snippet
    • component-data, aka "framework support"
    • template-interpolation
    • vti
    • perf: Ask for performance profile as well.
    • jsx: Vue's JSX/TSX support. Vetur doesn't control language features in JS/TS files, so we can't easily change the editing experience for JSX/TSX. Keep these issues open though.
    • docs
    • windows: Windows specific issues (usually caused by path handling)

To help out

A few words

Managing issues might feel like boring, unimportant work. However, it's a great first step to getting involved with the project.

Through issues, you become familiar with Vetur's features and bugs. Sometimes the process of helping another person identify and isolate a bug will even lead you to a code fix.

Thank you for helping out & glad to have you on board 🚢

Clone this wiki locally