Skip to content

Latest commit

 

History

History
42 lines (28 loc) · 2.54 KB

File metadata and controls

42 lines (28 loc) · 2.54 KB

Pull Request Checklist

You can go to dendron pull requests to see full details for items in this checklist.

General

Quality Assurance

  • add a test for the new feature
  • make sure all the existing tests pass
  • do a spot check by running your feature with our test workspace
  • after you submit your pull request, check the output of our integration test and make sure all tests pass
    • NOTE: if you running mac/linux, check the windows output and vice versa if you are developing on windows

Special Cases

  • if your tests changes an existing snaphot, make sure that snapshots are updated
  • if you are adding a new language feature (graphically visible in vscode/preview/publishing), make sure that it is included in test-workspace. We use this to manually inspect new changes and for auto regression testiing

Docs

  • Make sure that the PR title follows our commit style
  • Please summarize the feature or impact in 1-2 lines in the PR description
  • If your change reflects documentation changes, also submit a PR to dendron-site and mention the doc PR link in your current PR

Example PR Description

# feat: capitalize all foos

This changes capitalizes all occurences of `foo` to `Foo` 

Docs PR: <URL_TO_DOCS_PR>

Special Cases

First Time PR

  • sign the CLA which will be prompted by our github bot after you submit the PR
  • add your discord alias in the review so that we can give you the horticulturalist badge in our community

Analytics

  • if you are adding analytics related changes, make sure the Telemetry docs are updated