Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ci: Add PR checklist #5628

Merged
merged 14 commits into from
Mar 9, 2023
12 changes: 12 additions & 0 deletions .github/workflows/ci-pull-requests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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.
40 changes: 40 additions & 0 deletions CHECKLIST.yml
Original file line number Diff line number Diff line change
@@ -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.