n8n Docs는 누구나 기여할 수 있도록 열려 있습니다. 이 가이드는 기여 프로세스와 따라야 할 가이드라인을 다룹니다.

소개#

n8n Docs는 n8n의 공식 문서로, 시작하기부터 고급 워크플로 자동화까지 모든 내용을 다룹니다. n8n 팀이 관리하지만, 커뮤니티의 기여를 통해 설명을 개선하고, 콘텐츠를 업데이트하고, 오류를 수정하는 등 다양한 도움을 받을 수 있습니다.

모든 기여는 행동 강령(Code of Conduct)을 준수해야 하며, 이 기여 가이드와 스타일 가이드에 명시된 기준을 따라야 합니다. 이를 통해 n8n Docs 전반의 품질과 일관성을 보장합니다.

n8n Docs 콘텐츠는 GitHub 리포지터리에서 관리됩니다. 사이트는 GitBook으로 생성되며, 페이지는 콜아웃, 탭, 구조화된 페이지 요소와 같은 GitBook 전용 컴포넌트를 포함한 Markdown으로 작성됩니다.

기여 유형#

참여할 수 있는 주요 방법은 다음과 같습니다:

오탈자 및 사소한 오류 수정 오탈자, 깨진 링크, 또는 사소한 부정확한 내용을 수정합니다.

기존 페이지 개선 설명이 명확하지 않거나, 콘텐츠가 오래되었거나, 페이지에 중요한 정보가 누락된 경우 수정 및 추가를 제안할 수 있습니다.

새 페이지 제안 문서에 완전히 누락된 내용이 있다고 생각되면 알려주세요. 무언가를 작성하기 전에 필요한 콘텐츠를 설명하는 이슈를 먼저 열어주세요. 이렇게 하면 팀이 해당 콘텐츠가 범위에 맞는지 확인할 수 있고, 이미 진행 중인 작업과 중복되는 것을 방지할 수 있습니다. 승인된 후 직접 콘텐츠를 작성하고 싶다면 이슈에 그 사실을 언급해주세요.

코드 변경과 함께 문서 업데이트 n8n 메인 리포지터리에서 PR을 여는 경우 — 예를 들어 노드를 추가하거나, 구성 옵션을 변경하거나, 문서화된 동작에 영향을 주는 버그를 수정하는 경우 — 해당 변경 사항을 반영하는 문서 PR을 열어주세요.

문제 보고 문서에서 문제를 발견했지만 직접 수정할 수 없는 경우도 있습니다. 무엇이 잘못되었는지 설명하는 이슈를 열어주시면 n8n Docs 팀이 처리하겠습니다.

제출하지 말아야 할 항목#

다음과 같은 유형의 기여는 받지 않습니다:

• 완전 자동 생성 페이지에 대한 수정. 이러한 페이지는 n8n 워크플로를 통해 자동으로 생성되고 최신 상태로 유지됩니다. 문제를 발견하면 페이지를 직접 편집하는 대신 이슈를 열어주세요. 완전 자동 생성 페이지는 frontmatter의 generated: true 필드로 식별할 수 있습니다.
• 호환 가능한 옵션의 큐레이션 목록에 제공업체나 도구를 추가하는 것을 포함한, 모든 종류의 홍보성 또는 상업적 콘텐츠. 문서 내 이러한 목록은 일반적으로 가장 널리 사용되는 옵션만 다루며, 전체 목록이 아닙니다 — 저희는 벤더 중립성을 지향하며, 명확한 이유가 있을 때만 목록을 확장합니다.
• 개인 취향에 따른 변경 — 이미 스타일 가이드를 따르는 콘텐츠를 본인이 선호하는 표현이나 스타일로 대체하는 수정.
• 이 가이드라인을 무시한 기여. 제출물이 스타일 가이드나 기여 가이드라인을 따르려는 시도를 전혀 하지 않은 것이 명백한 경우, 검토 없이 종료될 수 있습니다.

작성 가이드#

n8n Docs는 Microsoft Writing Style Guide를 따라 2인칭("you"), 현재 시제, 능동태를 사용한 평이하고 직접적인 언어를 사용합니다. 문장은 짧고 전문 용어 없이 유지하고, 축약형을 사용하세요.

자세한 내용은 n8n 스타일 가이드를 참고하세요.

콘텐츠 유형#

n8n Docs는 몇 가지 뚜렷이 구분되는 페이지 유형을 사용합니다. 작업 중인 유형을 파악하면 올바른 구조를 따르고 적절한 템플릿을 사용하는 데 도움이 됩니다. 각 유형에는 document-templates/ 폴더에 템플릿이 있습니다:

• 통합 노드: 노드에 대한 레퍼런스 문서입니다. 노드 유형에 맞는 템플릿을 사용하세요 — app, core, trigger, 또는 cluster 노드.
• 자격 증명: 통합을 인증하는 방법입니다 (템플릿).
• 일반적인 문제: 노드에 대해 알려진 문제와 해결 방법입니다 (템플릿).
• 기능: n8n 기능에 대한 사용 방법 및 레퍼런스 문서입니다 (템플릿).
• 튜토리얼: 무언가를 구축하는 단계별 가이드입니다 (템플릿).

AI를 사용하여 기여 초안 작성하기#

AI 도구를 사용하여 기여 내용을 작성하거나 개선하는 것은 문제없으며 환영합니다.

원하는 AI 도구와 함께 skills/n8n-docs-author/SKILL.md에 있는 n8n Docs 스킬 파일을 사용하는 것을 권장합니다. 이 파일은 저희 스타일 가이드를 압축한 것으로, n8n의 스타일과 문서 작성 관례에 대한 컨텍스트를 에이전트에 제공합니다. 이를 통해 처음부터 더 나은 결과물을 얻을 수 있고, 이후 편집 작업도 줄어듭니다.

작동 방식

n8n Docs GitHub 리포지터리의 로컬 포크 내에서 AI 코딩 에이전트를 사용하는 경우, 스킬이 자동으로 로드될 수 있습니다. 예를 들어, 리포지터리 루트의 CLAUDE.md 파일이 Claude Code에게 이 스킬을 가리키므로 별도의 작업이 필요하지 않습니다.

리포지터리를 포크하지 않았거나, 스킬을 자동으로 로드하지 않는 도구를 사용 중이더라도 여전히 이를 활용할 수 있습니다. SKILL.md, reference.md, 그리고 스타일 가이드의 내용을 에이전트의 컨텍스트에 복사한 다음, 문서 기여를 작성하거나 검토할 때 해당 가이드를 따르도록 요청하세요.

사용 방법

평소와 같이 에이전트에게 문서를 작성하거나 검토하도록 요청하세요. 모드를 명확히 하려면 다음과 같이 요청합니다:

• 작성: "X에 대한 트리거 노드 페이지를 작성해줘."
• 편집: "스타일 가이드 위반 사항을 수정하도록 이 페이지를 편집해줘."
• 검토: "이 페이지를 스타일 가이드에 따라 검토해줘."

검토를 요청하면 에이전트는 심각도별로 그룹화된 문제 목록을 제안된 수정 사항과 함께 표 형태로 반환합니다.

기여 방법#

다양한 방법으로 기여할 수 있습니다:

브라우저에서 페이지 편집하기#

이 방법은 단일 페이지에 대한 빠른 수정에 가장 적합합니다. n8n Docs의 아무 페이지에서나 Edit this page를 클릭하면 GitHub가 변경 사항을 만들고 풀 리퀘스트(PR, 문서에 변경 사항을 추가하기 위한 공식 제안)를 여는 과정을 안내합니다.

사전 준비 사항: GitHub 계정.

1. n8n Docs의 아무 페이지에서나 우측 상단의 드롭다운 메뉴에서 Edit를 클릭합니다. 그러면 n8n Docs GitHub 리포지터리의 해당 페이지로 이동합니다.
2. 연필 아이콘을 클릭하여 페이지를 편집합니다.

먼저 리포지터리를 포크하라는 메시지가 표시될 수 있습니다. Fork this repository를 클릭하면 GitHub가 자동으로 포크를 생성합니다.

3. 텍스트 편집기에서 수정 작업을 진행한 다음 Commit changes > Propose changes를 클릭합니다.

GitHub가 풀 리퀘스트를 준비해줍니다.

4. 풀 리퀘스트의 제목과 설명을 확인하고, 필요하면 수정합니다. 만족스러우면 Create pull request를 클릭합니다.

일반 체크리스트를 따랐는지 확인하고, 누락된 부분이 있으면 필요에 따라 PR을 수정하세요. n8n Docs 팀이 풀 리퀘스트를 검토하며, 승인되면 병합하여(제안한 수정 사항을 게시하여) 반영합니다.

리포지터리를 로컬로 포크하기#

이 방법은 더 큰 규모의 변경, 새 페이지, 또는 여러 파일에 걸친 작업에 적합합니다.

사전 준비 사항: GitHub 계정, Git, 그리고 로컬에 설치된 텍스트 편집기 또는 IDE.

1. GitHub에서 n8n Docs 리포지터리를 포크하고 로컬에 클론합니다.

2. 변경 사항을 위한 새 브랜치를 생성합니다.

3. 관련 페이지에서 변경 작업을 진행합니다. 새 페이지를 추가하는 경우, 내비게이션에 표시되도록 스페이스의 SUMMARY.md 파일에 추가하세요. 스타일 가이드의 페이지 내비게이션 섹션을 참고하세요.

4. Vale로 프로즈(prose)를 린트합니다. 설치한 후(macOS에서는 brew install vale — 다른 시스템은 Vale 설치 가이드 참고), 리포지터리 루트에서 실행합니다:

   vale docs/                 # lint a directory
   vale docs/path/to/file.md  # lint a single file
   

   Vale 스타일 규칙은 리포지터리에 포함되어 있으므로 별도 설정이 필요하지 않습니다. 계속 진행하기 전에 모든 오류와 경고를 수정하세요.

5. 브랜치를 커밋하고 GitHub에 푸시합니다.

6. 포크에서 main을 대상으로 풀 리퀘스트를 엽니다.

일반 체크리스트를 따랐는지 확인하고, 누락된 부분이 있으면 필요에 따라 PR을 수정하세요. n8n Docs 팀이 풀 리퀘스트를 검토하며, 승인되면 병합합니다.

변경 사항 미리보기

풀 리퀘스트를 열면 GitBook이 자동으로 변경 사항의 미리보기를 빌드하고 PR에 링크를 연결합니다. 이 미리보기를 사용해 변경 사항이 실제 사이트에서 어떻게 렌더링되는지 확인하세요. 위에서 설명한 브라우저 방법과 로컬 방법 모두 풀 리퀘스트를 거치므로, 로컬에서 사이트를 빌드할 필요는 없습니다.

이슈 열기#

문제를 발견했지만 직접 콘텐츠를 편집하고 싶지 않거나, 작성하기 전에 새 콘텐츠를 제안하고 싶다면 대신 GitHub 이슈를 열 수 있습니다.

1. n8n Docs 이슈 페이지로 이동합니다.
2. 새 이슈를 생성하기 전에 열려 있는 이슈를 검색하여 이미 존재하는지 확인합니다.
3. New issue를 클릭하고 가장 관련 있는 이슈 유형을 선택합니다.
4. 제목과 설명을 작성합니다. 페이지 URL, 무엇이 잘못되었거나 누락되었는지, 그리고 제안 사항을 가능한 한 자세히 포함하세요.
5. Submit new issue를 클릭합니다.

n8n Docs 팀이 이슈를 분류하고, 추가 정보가 필요한 경우 후속 조치를 취합니다.

일반 체크리스트#

n8n Docs를 수정하는 풀 리퀘스트를 제출하기 전에, 기여 내용이 다음 항목을 모두 충족하는지 확인하세요:

• 필요한 모든 파일과 이미지가 포함되어 있습니다.
• 새 페이지가 있는 경우 내비게이션에 표시되도록 스페이스의 SUMMARY.md에 추가되어 있습니다.
• 모든 서식이 스타일 가이드를 따릅니다.
• 변경 사항이 오류 없이 Vale 프로즈 린팅을 통과합니다(로컬에서 기여한 경우 — 리포지터리를 로컬로 포크하기 섹션 참고).
• 모든 링크가 정상 작동하며 올바른 위치로 연결됩니다.
• PR에 변경한 내용과 그것이 필요한 이유가 설명되어 있습니다.
• 허용되지 않는 유형의 제출물을 작성하지 않았습니다
• 행동 강령과 기여자 라이선스 계약을 읽고 동의했습니다.

검토 프로세스#

풀 리퀘스트를 열면 n8n Docs 팀이 이를 검토한 후 병합하거나, 변경을 요청하거나, 종료합니다. 다음과 같은 과정을 예상할 수 있습니다:

타임라인 팀은 가능한 한 빠르게 풀 리퀘스트를 검토하는 것을 목표로 합니다. 복잡하거나 규모가 큰 기여는 더 오래 걸릴 수 있습니다. 메인 코드베이스의 PR과 연결된 기여는 해당 메인 PR이 병합될 때까지 검토되지 않습니다.

레이블 팀은 레이블을 사용해 PR의 상태를 전달합니다:

전체 레이블 목록은 GitHub 리포지터리에서 확인하세요

PR이 종료될 수 있는 이유 콘텐츠가 범위를 벗어나거나, 기존 문서와 중복되거나, 스타일 또는 기여 가이드라인을 충족하지 않거나, 변경이 요청된 후 업데이트되지 않은 경우 풀 리퀘스트가 병합되지 않고 종료될 수 있습니다. PR이 잘못 종료되었다고 생각되면 언제든지 댓글로 설명을 요청해 주세요.

풀 리퀘스트를 열면 라이선스 섹션에 설명된 조건에 동의하는 것으로 간주됩니다.

라이선스#

n8n은 fair-code 라이선스를 따릅니다. n8n Docs에 기여하면 해당 기여도 동일한 라이선스 하에 제공됩니다. 자세한 내용은 라이선스 문서를 참고하세요.

도움 받기#

기여에 대해 궁금한 점이 있다면 다음과 같은 곳에서 도움을 받을 수 있습니다:

• 커뮤니티 포럼: 콘텐츠, 스타일, 또는 기여 프로세스에 대한 질문은 documentation 카테고리에 게시하세요.
• Discord: 좀 더 편하게 질문하거나 빠른 피드백을 원하면 #docs 채널에 참여하세요.

문서 팀의 주의를 특별히 끌고 싶다면 풀 리퀘스트나 이슈에 @n8n-io/docs를 태그하세요.