Skip to main content
Module

x/vega_lite/.github/PULL_REQUEST_TEMPLATE.md

A concise grammar of interactive graphics, built on Vega.
vega/vega-lite
Latest
File

Please:

  • Make the pull requests (PRs) atomic (fix one issue at a time). Multiple relevant issues that must be fixed together? Make atomic commits so we can easily review each issue.
  • Provide a concise title as a semantic commit message (e.g. “fix: correctly handle undefined properties”) so we can easily copy it to the release note.
    • Use imperative mood and present tense.
  • Mention relevant issues in the description (e.g., Fixes #1 / Fixes part of #1).
  • Lint and test (Run yarn test).
  • Rebase onto the latest master branch.
  • Review your changes before sending the PR (to ensure code quality).
  • For new features:
    • Add new unit tests.
    • Update the documentation under site/docs/ + add examples.

Tips: