Skip to content

Commit 9ffb6a1

Browse files
committed
Fix language and add CoC
1 parent 48dea2d commit 9ffb6a1

File tree

9 files changed

+91
-15
lines changed

9 files changed

+91
-15
lines changed

CODE_OF_CONDUCT.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at [email protected]. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq

LICENSE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ Licensor: n8n GmbH
215215
same "printed page" as the copyright notice for easier
216216
identification within third-party archives.
217217

218-
Copyright [yyyy] [name of copyright owner]
218+
Copyright [2020] [n8n GmbH]
219219

220220
Licensed under the Apache License, Version 2.0 (the "License");
221221
you may not use this file except in compliance with the License.

docs/getting-started/creating-your-first-workflow.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ Don't forget to save the workflow and then click on the Activate button on the t
8484

8585
![Creating the NoOp node](./images/creating-your-first-workflow/creating-the-noop-node.gif)
8686

87-
I raised the value of *Value 2* in the *IF* node from 18 to 27 just to see what the SMS would look like. This is how the finished workflow and the SMS looked like.
87+
I raised the value of *Value 2* in the *IF* node from 18 to 27 to see what the SMS would look like. This is how the finished workflow and the SMS looked like.
8888

8989
![Workflow running with true output from the IF node](./images/creating-your-first-workflow/workflow-running-with-true-output-from-the-if-node.png)
9090

docs/getting-started/key-components.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ A connection establishes a link between nodes to route data through the workflow
88

99
## Node
1010

11-
A node is an entry point for retrieving data, a function to process data or an exit for sending data. The data process includes filtering, recomposing and changing data. There can be one or several nodes for your API, service or app. You can easily connect multiple nodes, which allows you to create simple and complex workflows with them intuitively.
11+
A node is an entry point for retrieving data, a function to process data or an exit for sending data. The data process includes filtering, recomposing and changing data. There can be one or several nodes for your API, service or app. You can connect multiple nodes, which allows you to create simple and complex workflows with them intuitively.
1212

1313
For example, consider a Google Sheets node. It can be used to retrieve or write data to a Google Sheet.
1414

docs/nodes/creating-nodes/create-node.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Creating a Node
22

3-
It is quite easy to create your own nodes in n8n. Mainly three things have to be defined:
3+
To create your own nodes in n8n, mainly three things have to be defined:
44

55
1. Generic information like name, description, image/icon
66
1. The parameters to display via which the user can interact with it
@@ -31,7 +31,7 @@ If you want to create multiple custom nodes which are either:
3131
- Require many or large dependencies
3232

3333
It is best to create your own `n8n-nodes-module` which can be installed separately.
34-
That is a simple npm package that contains the nodes and is set up in a way
34+
That is an npm package that contains the nodes and is set up in a way
3535
that n8n can automatically find and load them on startup.
3636

3737
When creating such a module the following rules have to be followed that n8n
@@ -49,7 +49,7 @@ the above can be found here:
4949

5050
### Setup to use n8n-nodes-module
5151

52-
To use a custom `n8n-nodes-module`, it simply has to be installed alongside n8n.
52+
To use a custom `n8n-nodes-module`, it needs to be installed alongside n8n.
5353
For example like this:
5454

5555
```bash
@@ -116,18 +116,18 @@ All code of n8n is written in TypeScript and hence, the nodes should also be wri
116116

117117
### Use the built in request library
118118

119-
Some third-party services have their own libraries on npm which make it easier to create an integration. It can be quite tempting to use them. The problem with those is that you add another dependency and not just one you add but also all the dependencies of the dependencies. This means more and more code gets added, has to get loaded, can introduce security vulnerabilities, bugs and so on. So please use the built-in module which can be used like this:
119+
Some third-party services have their own libraries on npm which make it easier to create an integration. It can be quite tempting to use them. The problem with those is that you add another dependency and not only one, you add but also all the dependencies of the dependencies. This means more and more code gets added, has to get loaded, can introduce security vulnerabilities, bugs, and so on. So please use the built-in module which can be used like this:
120120

121121
```typescript
122122
const response = await this.helpers.request(options);
123123
```
124124

125-
That is simply using the npm package [`request-promise-native`](https://github.com/request/request-promise-native) which is the basic npm `request` module but with promises. For a full set of `options` consider looking at [the underlying `request` options documentation](https://github.com/request/request#requestoptions-callback).
125+
That is using the npm package [`request-promise-native`](https://github.com/request/request-promise-native) which is the basic npm `request` module but with promises. For a full set of `options` consider looking at [the underlying `request` options documentation](https://github.com/request/request#requestoptions-callback).
126126

127127

128128
### Reuse parameter names
129129

130-
When a node can perform multiple operations like edit and delete some kind of entity, for both operations, it would need an entity-id. Do not call them "editId" and "deleteId" simply call them "id". n8n can handle multiple parameters with the same name without a problem as long as only one is visible. To make sure that is the case, the "displayOptions" can be used. By keeping the same name, the value can be kept if a user switches the operation from "edit" to "delete".
130+
When a node can perform multiple operations like edit and delete some kind of entity, for both operations, it would need an entity-id. Do not call them "editId" and "deleteId", call them "id". n8n can handle multiple parameters with the same name without a problem as long as only one is visible. To make sure that is the case, the "displayOptions" can be used. By keeping the same name, the value can be kept if a user switches the operation from "edit" to "delete".
131131

132132

133133
### Create an "Options" parameter

docs/nodes/nodes-library/nodes/Twilio/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,4 @@ The start node exists by default when you create a new workflow.
3030
3. Enter the phone number to which you'll be sending the message in the *To* field.
3131
4. In case you want to send a Whatsapp message, toggle the *To Whatsapp* button.
3232
5. Enter you message in the *Message* field.
33-
6. Click on *Exceute Node* to run the workflow.
33+
6. Click on *Execute Node* to run the workflow.

docs/reference/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ export N8N_SSL_CERT=/data/certs/server.pem
154154

155155
The timezone is set by default to "America/New_York". For instance, it is used by the
156156
Cron node to know at what time the workflow should be started. To set a different
157-
default timezone simply set `GENERIC_TIMEZONE` to the appropriate value. For example,
157+
default timezone, set `GENERIC_TIMEZONE` to the appropriate value. For example,
158158
if you want to set the timezone to Berlin (Germany):
159159

160160
```bash

docs/reference/data/sensitive-data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
To avoid passing sensitive information via environment variables, "_FILE" may be
44
appended to some environment variables. It will then load the data from a file
5-
with the given name. That makes it possible to load data easily from
5+
with the given name. That makes it possible to load data from
66
Docker and Kubernetes secrets.
77

88
The following environment variables support file input:

docs/reference/workflow.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,17 +68,17 @@ An "Error Workflow" can be set in the Workflow Settings which can be accessed by
6868

6969
## Share Workflows
7070

71-
All workflows are JSON and can be shared very easily.
71+
All workflows are JSON and can be shared with others.
7272

7373
There are multiple ways to download a workflow as JSON to then share it with other people via Email, Slack, Skype, Dropbox, …
7474

7575
1. Press the "Download" button under the Workflow menu in the sidebar on the left. It then downloads the workflow as a JSON file.
7676
1. Select the nodes in the editor which should be exported and then copy them (Ctrl + c). The nodes then get saved as JSON in the clipboard and can be pasted wherever desired (Ctrl + v).
7777

78-
Importing that JSON representation again into n8n is as easy and can also be done in different ways:
78+
Importing that JSON representation again into n8n can also be done in different ways:
7979

8080
1. Press "Import from File" or "Import from URL" under the Workflow menu in the sidebar on the left.
81-
1. Copy the JSON workflow to the clipboard (Ctrl + c) and then simply pasting it directly into the editor (Ctrl + v).
81+
1. Copy the JSON workflow to the clipboard (Ctrl + c) and then pasting it directly into the editor (Ctrl + v).
8282

8383

8484
## Workflow Settings

0 commit comments

Comments
 (0)