Review

Summary

This goes into how we do code review (via pull requests)

Process

Work in Progress

  • if your still iterating on your pull request or if your working on feedback but its not ready yet, put your PR into draft mode until it is ready

Commit Style

We follow conventional commits.

This means commits follow the following format

{category}({scope}): {description}

An example commit:

enhance(publish): speed up publishing by 500%

Checklist

first time pull request

  • if its your first pull request to Dendron, watch out for the CLA bot that will ask you to agree to Dendron's CLA
  • if its your first pull request and you're on our Discord, make sure that Kevin gives you the horticulturalist (Private) role πŸ‘¨β€πŸŒΎπŸ‘©β€πŸŒΎ

general

  • 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
  • if your change reflects documentation changes, also submit a PR to dendron-site and mention the doc PR link in your current PR
  • 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
  • (optional) ping @Dendron Team in the #dev channel of our discord - we usually respond to PRs within 24h

QA Checklist

No note with name dendron.dev.qa.sop found



Children

  1. PR Checklist