Skip to content

Add custom nodes conventions and patterns guide - #417

Merged
junminahn merged 1 commit into
mainfrom
feat/CCP-4845
Jul 30, 2026
Merged

Add custom nodes conventions and patterns guide#417
junminahn merged 1 commit into
mainfrom
feat/CCP-4845

Conversation

@junminahn

Copy link
Copy Markdown
Collaborator

Summary

Adds a new documentation guide for the community-nodes package that captures the conventions and patterns used across custom n8n nodes.

What’s included

  • Repository layout for custom nodes, credentials, tests, icons, and build output
  • Package-level conventions for community-nodes metadata, tooling, dependency policy, and scripts
  • Node and credential file naming conventions and description shape guidance
  • Shared helper patterns for reusable node logic
  • Execution, webhook, HTTP request, environment configuration, and error-handling conventions
  • TypeScript, lint, and testing guidance specific to the package
  • Documentation structure and style expectations for node docs
  • A checklist for adding new nodes
  • A reference table of existing nodes and their associated styles/credentials

Impact

This change is documentation-only and does not affect runtime behavior. It provides a single source of truth for contributors adding or reviewing custom nodes in the repository.

Files changed

  • docs/community-nodes/conventions-and-patterns.md

@sonarqubecloud

Copy link
Copy Markdown

@ratheesh-aot ratheesh-aot left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM

@junminahn
junminahn merged commit e0baa65 into main Jul 30, 2026
8 checks passed
@junminahn
junminahn deleted the feat/CCP-4845 branch July 30, 2026 23:45
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