Skip to content

docs: Add a guide to build a trigger and an action, CONTRIBUTING and issue forms - #43

Merged
johnxie merged 1 commit into
masterfrom
docs/learn-and-contribute
Nov 19, 2026
Merged

johnxie merged 1 commit into
masterfrom
docs/learn-and-contribute

Conversation

@johnxie

@johnxie johnxie commented Nov 19, 2026

Copy link
Copy Markdown
Member

What a newcomer could not find before

  • How to run the Zapier app on their own computer against their own account.
  • How one trigger and one action are built, file by file.
  • How to add a new trigger or action, and how to test it.
  • How a merged change reaches users on Zapier, n8n and Make.
  • A list of what the public Taskade API offers today, with links.
  • An issue form for a bug or a request. The repository had no CONTRIBUTING.md and no issue templates.

What they find now

  • README.md: one sentence on what the repository is, three links (use an integration, learn how it is built, add a trigger or an action), a table of what ships today on each platform, taken from the code, and a table of the public API areas with links to taskade.com/docs. The Zapier key table, the release steps and the roadmap stay.
  • docs/build-a-trigger-and-an-action.md: a walk-through of the New Comment trigger (new_comment) and the Create Task action (create_task): registration, OAuth2, input fields, a dynamic dropdown, the API call, the sample, deduplication, the test, and zapier invoke. Then the n8n Task > Create operation and the n8n trigger. It ends with a 6-step checklist. Each excerpt is copied from the files at this commit, and a script confirmed that each one matches.
  • CONTRIBUTING.md: setup, the CI commands for each app, how to run the Zapier app with a personal access token in .env (authData_access_token), the rules (one integration in each pull request, keys never change, no secret in a fixture, product names in full), and how a release reaches users on each platform, as the workflows and docs state it.
  • .github/ISSUE_TEMPLATE/: "Integration bug", with a public-issue notice and a required privacy checkbox, "New trigger or action request", and config.yml with links to the API docs and to account help.
  • src/test/triggerAndAction.test.ts: tests for the trigger and the action that the guide walks through. No key, version or app behavior changes.

Commands that I ran (Node 22.22.1)

yarn install --frozen-lockfile && yarn lint && yarn build && yarn test     # 29 tests pass
npx --yes --package zapier-platform-cli@17.4.0 zapier validate --without-style
npx --yes --package zapier-platform-cli@17.4.0 zapier invoke trigger get_all_spaces   # with a fake token: runs locally, the API refuses the token
cd packages/n8n-nodes-taskade && npm ci --ignore-scripts && npm run lint && npm test && npm run build   # 49 tests pass
npm run scan -- <scanner prefix>                                         # source and tarball pass
node packages/make-app-taskade/test/validate.mjs                         # PASS

Every external link returns 200, except the two npmjs.com package pages, which show a bot check to scripts. The npm registry confirms both packages. Every relative link and anchor resolves.

How to check

  1. Read the README on this branch and follow each of the three links.
  2. Run the commands in CONTRIBUTING.md for one app.
  3. Open the guide beside src/triggers/publicWebhook.ts and src/creates/createTask.ts, and compare the excerpts.

Notes

…issue forms

- README: one-line purpose, three doors (use, learn, add), a table of what
  ships today on Zapier, n8n and Make, and links to the public API docs.
- docs/build-a-trigger-and-an-action.md: a walk-through of the New Comment
  trigger and the Create Task action of the Zapier app, with excerpts from
  the code, then the n8n Task > Create operation and the n8n trigger, and a
  6-step checklist to add your own.
- CONTRIBUTING.md: setup, the CI commands for each app, how to run the
  Zapier app against your own account with zapier invoke, the rules, and
  how a merged change reaches users.
- Issue forms for an integration bug and a new trigger or action request.
- src/test/triggerAndAction.test.ts: tests for the trigger and the action
  that the guide walks through. No app behavior changes.
Copilot AI lite review requested due to automatic review settings November 19, 2026 00:16
@johnxie
johnxie merged commit 56c2323 into master Nov 19, 2026
6 checks passed
@johnxie
johnxie deleted the docs/learn-and-contribute branch November 19, 2026 00:17

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

No active review issues are reported, supporting approval of the documentation, contribution guidance, issue forms, and focused tests included in the change.

No open issues 🎉

What changed in this PR

This PR improves contributor onboarding for the Taskade integrations repository by documenting how the Zapier and n8n integrations are structured, developed, tested, and released, while adding contribution guidance, issue forms, and focused Zapier tests.

Changes:

  • Expands README.md with platform status, current capabilities, public API references, and contributor navigation.
  • Adds a detailed trigger/action development guide and CONTRIBUTING.md covering setup, testing, local invocation, contribution rules, and release processes.
  • Adds GitHub issue forms and tests for the documented new_comment trigger and create_task action.
File Description
src/​test/​triggerAndAction.test.ts Adds focused tests for the documented New Comment trigger and Create Task action.
README.md Documents platform availability, shipped capabilities, public API references, development guidance, and release information.
docs/​build-a-trigger-and-an-action.md Walks through implementing, testing, and invoking Zapier and n8n triggers and actions.
CONTRIBUTING.md Provides setup, testing, contribution rules, issue-reporting guidance, and platform release procedures.
.github/​ISSUE_TEMPLATE/​new-trigger-or-action.yml Adds a structured request form for new triggers, actions, and searches.
.github/​ISSUE_TEMPLATE/​integration-bug.yml Adds a privacy-aware integration bug report form.
.github/​ISSUE_TEMPLATE/​config.yml Adds API documentation and account-support links to the issue chooser.

Review effort: Lite

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants