From 2c1afcc60989addd3eecb486b4aa25f13a2350c8 Mon Sep 17 00:00:00 2001 From: Simon Katan Date: Wed, 28 Feb 2024 17:13:50 +0000 Subject: [PATCH] docs: updated PR template --- pull_request_template.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/pull_request_template.md b/pull_request_template.md index b7081d6e..ab864a97 100644 --- a/pull_request_template.md +++ b/pull_request_template.md @@ -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