Skip to content

Latest commit

 

History

History
46 lines (28 loc) · 2.44 KB

CONTRIBUTING.md

File metadata and controls

46 lines (28 loc) · 2.44 KB
Raw

Contributing

If you want to contribute to this repository - thank you! Before you start, have a look at the existing documentation to get an idea of the structure and writing conventions n8n uses. In writing your documentation, please follow the guidelines described below, to ensure quality and consistency with n8n styles.

Documenting nodes

  • Nodes and trigger nodes: Create a directory with the name of the node at docs/integrations/builtin/app-nodes/ or docs/integrations/builtin/trigger-nodes/ containing:

    • A text file named n8n-nodes-base.<node-name>.md describing the functionality of the relevant node.

  • Credentials: Create a document with the name of the node at docs/integrations/builtin/credentials/ containing:

    • A text file with the node name describing how to obtain credentials for the relevant node.

A standard node doc includes the following parts:

  • Node description
    • Describe the purpose and function of the node.
  • Operations
    • Enter the resources and operations exactly as they're named in the nodes.

In the credentials doc:

  • If there is more than one authentication method, list OAuth first.
  • If possible, avoid documenting external products. Instead, provide links to the relevant product documentation. For example, for guidance on getting credentials (such as how to get an API token for a service), provide a link to the product's API authentication docs.

Style

n8n uses the Microsoft Writing Style Guide.

Refer to Styles for a quickstart, and guidance on style linting.

General checklist

Before submitting a PR, make sure your contribution ticks all these boxes:

  • All necessary files and images are included.
  • All links are working and direct to the right location.
  • All documentation files end with an empty newline.
  • The commit message describes clearly and succinctly the changes you made.
  • The PR explains clearly and succinctly the changes you made and why they're necessary.
  • You have read and accepted the code of conduct and contributor license agreement.

n8n's license

Be aware that n8n is fair code licensed. For more information, refer to our License documentation.