Skip to content

Commit

Permalink
Merge pull request #126 from oaknational/chore/update-pr-template
Browse files Browse the repository at this point in the history
docs: updated PR template
  • Loading branch information
kimon-satan authored Feb 28, 2024
2 parents e41eb1b + 2c1afcc commit e8e56d6
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion pull_request_template.md
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

0 comments on commit e8e56d6

Please sign in to comment.