-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #126 from oaknational/chore/update-pr-template
docs: updated PR template
- Loading branch information
Showing
1 changed file
with
22 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,24 @@ | ||
# How to review this PR | ||
* Don't delete this text block * | ||
|
||
** Leave this text block for the reviewer ** | ||
|
||
- Check [component hierarchy](https://miro.com/app/board/uXjVNnKBgyk=/?share_link_id=59445593794) is followed correctly | ||
- Check the design [Heuristics](https://lively-meringue-8ebd43.netlify.app/?path=/docs/docs-howtodesigncomponents--docs#heuristics-for-component-design) have been followed | ||
- Check [naming conventions](https://lively-meringue-8ebd43.netlify.app/?path=/docs/docs-namingconventions--docs) have been applied | ||
- Check for these gotchyas: | ||
- Missing exports for Oak components | ||
- Accidental export of Internal components | ||
- Circular dependencies | ||
- Code duplication (via not using base components) | ||
- Non-functional storybook | ||
- No tests for logic | ||
|
||
# Add your PR description below | ||
|
||
## Link to the design doc | ||
|
||
## A link to the component in the deployment preview | ||
|
||
## Testing instructions | ||
|
||
## ACs |