Skip to content

Latest commit

 

History

History
99 lines (59 loc) · 4.09 KB

CONTRIBUTING.md

File metadata and controls

99 lines (59 loc) · 4.09 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.

Before you start

Style

n8n uses the Microsoft Writing Style Guide.

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

n8n's license

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

Writing docs

You can either:

  • Check out the docs repository and work on your local machine.
  • Make your changes directly in GitHub.

These instructions are for external users. Members of the n8n organization don't need to fork the repository.

Working locally

This method allows you to work in your own text editor, and preview your work while editing.

You need Git installed, and a GitHub account.

Fork the documentation repository.

Then clone your fork:

git clone https://github.com/<your-username>/n8n-docs.git
cd n8n-docs
git checkout -b <branch-name>

Make your changes. Push your branch:

git add *
git commit -m "<short summary of changes>"
git push --set-upstream origin <branch-name>

In GitHub, create a pull request to merge the work from your fork to main in the docs repository.

Writing in GitHub

This method is fine for small changes, but not recommended for larger pieces of work.

You need a GitHub account.

Follow GitHub's documentation on editing files.

Previewing your work

You can build the docs locally to preview them, or submit a pull request. All pull requests automatically trigger a preview build.

For instructions on previewing the docs locally, refer to the README.

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 the changes you made.
  • The PR explains the changes you made and why they're necessary.
  • You have read and accepted the code of conduct and contributor license agreement.

Documenting nodes

n8n provides templates for node docs.

  • 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 get 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 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.