Skip to content

Pull Request Guidance

Pine edited this page Sep 3, 2020 · 4 revisions

When you send a PR, please follow this guidance:

  • Include integration test if applicable
  • Include a changelog entry for user-facing changes
  • Make CI green

Integration Test

There are a few integration test suites:

  • yarn test:lsp -> test/lsp
  • yarn test:int -> test/interpolation
  • yarn test:vue3 -> test/vue3
  • yarn test:grammar -> test/grammar

Note that you can use --grep to select tests to run. For example:

# only run completion tests
yarn test:lsp --grep completion

For adding test case for grammar integration test, see https://github.com/vuejs/vetur/wiki/Developing-TextMate-Grammar

For other cases, add a fixture file and then edit the corresponding tests. For example:

  • Add a fixture file in test/lsp/fixture/completion/template/
  • Modify test/lsp/features/completion/template.test.ts

Changelog

In CHANGELOG.md, at the end of the section for the upcoming release, add a new line that describes your changes.

Only describe user-facing changes. For example, new features and bug fixes. Below are changes that shouldn't include changelog entries:

  • Documentation / typo fixes
  • CI improvements

This line should look like 🙌 <Description of changes>. Thanks to contribution from <User>. <#issue-number>., for example:

  • 🙌 Listen to JSON file changes for TypeScript resolveJsonModule support. Thanks to contribution from [@yoyo930021](https://github.com/yoyo930021). #2095.
  • 🙌 Follow user's config while resolving autoImport path. Thanks to contribution from [@hikerpig](https://github.com/hikerpig). #1177 and #1753.
Clone this wiki locally