n8n-node 도구 사용#

검증된 커뮤니티 노드를 만드는 모든 개발자는 패키지를 생성하고 확인할 때 n8n-node 도구를 사용해야 합니다. 이는 다음과 같은 방식으로 n8n이 품질과 일관성을 보장하는 데 도움이 됩니다.

• 예상되는 패키지 파일 구조 생성
• package.json 파일에 필요한 메타데이터 및 구성 추가
• n8n의 표준에 맞춰 코드를 린트하기 쉽게 만듦
• 로컬 n8n 인스턴스에 노드를 로드하여 테스트할 수 있도록 허용

노드 유형#

• 노드는 기존 노드가 되어서는 안 됩니다. 기존 노드를 개선한 것이라면 대신 풀 리퀘스트를 생성하세요.
• n8n은 현재 로직 또는 흐름 제어 노드를 승인하지 않습니다.
• 각 패키지는 정확히 하나의 서드파티 서비스와 통합해야 합니다. 동일한 서비스에 대한 트리거 노드는 메인 노드와 함께 포함될 수 있습니다. 여러 관련 없는 API를 감싸거나 여러 서비스에 대한 프록시 계층 역할을 하는 패키지는 일반적으로 검증 대상이 되지 않습니다. 각 서비스는 별도의 개별 패키지로 제출하세요.

패키지 소스 검증#

• npm 패키지 리포지터리 URL이 예상되는 GitHub 리포지터리와 일치하는지 확인하세요.
• 패키지 작성자/유지 관리자가 npm과 리포지터리 간에 일치하는지 확인하세요.
• npm의 git 링크가 작동하고 리포지터리가 공개되어 있는지 확인하세요.
• 패키지에 적절한 문서(README, 사용 예시 등)가 있는지 확인하세요.
• 패키지 라이선스가 MIT인지 확인하세요.
• 패키지는 GitHub 액션에서 게시되어야 하며 출처 증명(provenance)을 포함해야 합니다.

외부 의존성 없음#

• 패키지를 가볍고 유지 관리하기 쉽게 유지하기 위해 패키지에 외부 의존성이 포함되지 않도록 하세요.

적절한 문서화#

• GitHub의 README든 관련 API 문서로의 링크든, 명확한 문서를 제공하세요.
• 사용 지침, 예시 워크플로, 그리고 필요한 모든 인증 세부 정보를 포함하세요.

환경 변수 또는 파일 시스템 접근 금지#

• 코드는 환경 변수와 상호 작용하거나 파일을 읽거나 쓰려고 시도해서는 안 됩니다.
• 필요한 모든 데이터는 노드 매개변수를 통해 전달하세요.

n8n 모범 사례 준수#

• 명확하고 일관된 코딩 스타일을 유지하세요.
• TypeScript를 사용하고 n8n의 노드 개발 가이드라인을 따르세요.
• 적절한 오류 처리 및 검증을 보장하세요.
• 린터가 통과하는지 확인하세요(즉, npx @n8n/scan-community-package n8n-nodes-PACKAGE 실행이 통과하는지 확인하세요).

영어만 사용#

• 노드 인터페이스와 모든 문서는 영어로만 작성되어야 합니다.
• 여기에는 매개변수 이름, 설명, 도움말 텍스트, 오류 메시지 및 README 콘텐츠가 포함됩니다.