From 71c349b071c2f66759f7f250a3c849710f8cad7e Mon Sep 17 00:00:00 2001
From: Mutasem Aldmour <4711238+mutdmour@users.noreply.github.com>
Date: Thu, 9 Mar 2023 12:49:37 +0100
Subject: [PATCH] ci: Add PR checklist (#5628)

* ci: Add PR checklist

* chore: add test change

* ci: add name

* ci: merge into workfow

* test: test action

* ci: add checklist

* ci: test checklist

* ci: remove comment

* ci: test checklist

* ci: add item to check item

* ci: update checklist items

* ci: add checklist item for migraitons

* ci: add hooks checklist item

* chore: remove comment
---
 .github/workflows/ci-pull-requests.yml | 12 ++++++++
 CHECKLIST.yml                          | 40 ++++++++++++++++++++++++++
 2 files changed, 52 insertions(+)
 create mode 100644 CHECKLIST.yml

diff --git a/.github/workflows/ci-pull-requests.yml b/.github/workflows/ci-pull-requests.yml
index c567d1baea..922cbbda96 100644
--- a/.github/workflows/ci-pull-requests.yml
+++ b/.github/workflows/ci-pull-requests.yml
@@ -117,3 +117,15 @@ jobs:
       containers: '[1]'
     secrets:
       CYPRESS_RECORD_KEY: ${{ secrets.CYPRESS_RECORD_KEY }}
+
+  checklist_job:
+    runs-on: ubuntu-latest
+    name: Checklist job
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v1
+      - name: Checklist
+        uses: wyozi/contextual-qa-checklist-action@master
+        with:
+          gh-token: ${{ secrets.GITHUB_TOKEN }}
+          comment-footer: Make sure to check off this list before asking for review.
diff --git a/CHECKLIST.yml b/CHECKLIST.yml
new file mode 100644
index 0000000000..77d30837d3
--- /dev/null
+++ b/CHECKLIST.yml
@@ -0,0 +1,40 @@
+paths:
+  "packages/**":
+    - If fixing bug, added test to cover scenario.
+    - If addressing forum or Github issue, added link to description.
+  "packages/**/*.ts":
+    - Added unit tests to cover new or updated functionality.
+  "**/*.vue":
+    - Used composition API for all new components.
+    - Added component or unit tests to cover functionality.
+  
+  # cli
+  "packages/cli/src/databases/migrations/**":
+    - Requested review from at least two engineers on migration. 
+    - Avoided irreversible data migrations.
+    - Avoided deleting or updating data keys.
+    - Wrote 'down' migration if possible.
+  "n8n/packages/cli/src/api/**":
+    - Added integration tests for new endpoints.
+
+  # editor ui
+  "packages/editor-ui/**/*.vue":
+    - Added E2E if adding new features.
+    - Used design system tokens (colors, spacings...) where possible.
+  "packages/editor-ui/src/mixins/restApi.ts":
+    - Avoided adding new methods. Only deleted from here.
+  "packages/editor-ui/src/mixins/**":
+    - Avoided adding new mixins (use composables instead). Only removed code from here.
+  "packages/editor-ui/src/views/NodeView.vue":
+    - Avoided adding code here. Only refactored to make it smaller. 
+  "packages/editor-ui/src/hooks/**":
+    - Avoided adding new hooks. Only refactored to move hooks to relevant store instead.
+
+  # nodes-base
+  "packages/nodes-base/nodes/**":
+    - Added workflow tests for nodes if possible.
+
+  # design-system
+  "packages/design-system/**/*.vue":
+    - Used design system tokens (colors, spacings...) where possible.
+    - Updated Storybook with new component or updated functionality.
\ No newline at end of file