Repository navigation
docs: Add a guide to build a trigger and an action, CONTRIBUTING and issue forms - #43
Merged
Merged
Conversation
…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.
There was a problem hiding this comment.
🟢 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.mdwith platform status, current capabilities, public API references, and contributor navigation. - Adds a detailed trigger/action development guide and
CONTRIBUTING.mdcovering setup, testing, local invocation, contribution rules, and release processes. - Adds GitHub issue forms and tests for the documented
new_commenttrigger andcreate_taskaction.
| 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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What a newcomer could not find before
CONTRIBUTING.mdand no issue templates.What they find now
new_comment) and the Create Task action (create_task): registration, OAuth2, input fields, a dynamic dropdown, the API call, the sample, deduplication, the test, andzapier 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..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.config.ymlwith links to the API docs and to account help.Commands that I ran (Node 22.22.1)
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
src/triggers/publicWebhook.tsandsrc/creates/createTask.ts, and compare the excerpts.Notes
README.md(one "Recipes" section). This PR does not add a recipes link, becauserecipes/is not onmasteryet. A rebase of docs(recipes): Add recipes for Make, n8n, Square and any app with an API key (#35) #36 can add its section after "Add a trigger or an action".packages/make-app-taskade/(fix(make): Use Make-valid module and RPC IDs, and pair the app #40).