First Time PR Review Checklist
First Time Specifics
- 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, add your discord handle so that we can award you the horticulturalist role when the PR is merged
Commit
- make sure your branch names adhere to our branch style
- make sure the commit message follows Dendron's commit style
- if this pull request is addressing an existing issue, make sure to link this PR to the issue that it is resolving.
- NOTE: make sure to read Addressing open issues
From Basics
Go to text →
Code
From Checklist
Go to text →
- code should follow Code Conventions
- sticking to existing conventions instead of creating new ones
Tests
From Checklist
Go to text →
- Write Tests
- Confirm existing tests pass
- Confirm manual testing
- Common cases tested
- 1-2 Edge cases tested
- If your tests changes an existing snapshot
Docs
From Checklist
Go to text →
- if your change reflects documentation changes, also submit a PR to dendron-site and mention the doc PR link in your current PR (NOTE: submit the PR against the
devbranch of the dendron-site repo)
From Checklist
Go to text →
- does this change introduce a new or better way of doing things that others need to be aware of? if so, an async should be created and a process added in Development or Packages
Backlinks