Please:
- Make your pull request atomic, fixing one issue at a time unless there are multiple relevant issues that would not make sense in isolation. For the latter case, please make atomic commits so we can easily review each issue.
- Please add new commit(s) when addressing comments, so we can see easily the new changeset (instead of the whole changeset).
- Provide a test case & update the documentation under
site/docs/ - Make lint and test pass. (Run
yarn lintandyarn test. If your change affects Vega outputs of some examples, runyarn build:example EXAMPLE_NAMEto re-compile a specific example oryarn build:examplesto re-compile all examples.) - Rebase onto the latest
masterbranch. - Provide a concise title that we can copy to our release note.
- Use imperative mood and present tense.
- Mention relevant issues. (e.g.,
#1)
- Make a pass over the whole changeset as if you're a reviewer yourself. This will help us focus on catching issues that you might not notice yourself. (If you're still working on your PR, you can add "[WIP]" prefix to the PR's title. When the PR is ready, you can then remove "[WIP]" and add a comment to notify us.)
Pro-Tip: https://medium.com/@greenberg/writing-pull-requests-your-coworkers-might-enjoy-reading-9d0307e93da3 is a nice article about writing a nice pull request.