mirrors/n8n-docs
2
0
Fork 0
mirror of https://github.com/n8n-io/n8n-docs.git synced 2025-11-20 17:48:34 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

add section on spam and labels to contributing (#3556)

Browse Source
This commit is contained in:
Deborah Barnard 2025-08-29 12:48:08 +01:00 committed by GitHub
parent fe443df70f
commit 4753fab451
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 41 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
.github/ISSUE_TEMPLATE/bug_report.md vendored
View File

@ -7,18 +7,19 @@ assignees: ''
---
**NOTE!**
> **NOTE**: This is for issues with _documentation_ of n8n. If the problem is actually a bug in the software, [file a bug here instead](https://github.com/n8n-io/n8n/issues). If you need help, [ask on the forum](https://community.n8n.io/c/questions/12).
This is for issues with _documentation_ of **n8n**. If the problem you are having is actually a bug in the software, please [file a bug here instead](https://github.com/n8n-io/n8n/issues).
## Where is the bug/mistake?
**Where is the bug/mistake?**
Please help us by pasting in the URL of the page or telling us the title.
**What problem did you find?**
A clear and concise description of what is wrong.
## What problem did you find?
A clear and concise description of what's wrong.
## Can you suggest a fix?
**Can you suggest a fix?**
For some issues, like a broken link, it will help us resolve them faster if you can indicate what you think the correct information would be.
**Additional context**
## Additional context
Add any other context about the problem here.

13
.github/ISSUE_TEMPLATE/new-docs-request.md vendored
View File

@ -1,19 +1,20 @@
---
name: New docs request
about: Suggest additional pages or information to improve docs
about: Suggest new pages or information to improve docs
title: "[DOCS-REQUEST] - "
labels: enhancement
assignees: ''
---
> **NOTE**: This is for the _documentation_ of n8n. For product ideas, or to get help, [use the forum](https://community.n8n.io/).
Thanks for helping us improve docs! Please give us as much information as you can about the changes you'd like to see.
**What information is missing?**
## What information is missing?
**Describe the page/pages you'd like**
## Describe the page/pages you'd like
**Additional context**
## Additional context
Add any other context or screenshots about the feature request here.

46
CONTRIBUTING.md
View File

@ -2,15 +2,34 @@
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
## Docs issues only
### Style
This repo is for the documentation site.
- Need help? [Ask on the forum](https://community.n8n.io/c/questions/12).
- Got a feature request or product idea? [Propose it on the forum](https://community.n8n.io/c/feature-requests/5).
- Found a bug in the product? [Product repo](https://github.com/n8n-io/n8n)
## Why we might reject your contribution
Due to an increase in spam and poor quality contributions, we've introduced new criteria and processes.
| Label | Action | Notes |
| ----- | ------ | ----- |
| `spam` | Close PR/issue; account blocked | This label is applied to things like empty issues. |
| `ai-slop` | Close PR/issue; account blocked | This label is applied when content is bad, wrong, and looks like it's probably the result of using AI. n8n isn't banning use of AI in contributions, so long as the contributions are high quality. |
| `low-effort-bad` | Close PR/issue; comment with contribution guidance; a second `low-effort-bad` leads to a block. | To avoid this, test your work to make sure it's accurate; follow the [style guide](https://github.com/n8n-io/n8n-docs/wiki/Styles); write meaningful titles and descriptions on your PR/issue. |
| `duplicate` | Close PR/issue; comment with contribution guidance; a second `duplicate` leads to a block. | To avoid this, check existing issues and PRs |
## Style
n8n uses the [Microsoft Writing Style Guide](https://docs.microsoft.com/en-us/style-guide/welcome/).
Refer to [Styles](https://github.com/n8n-io/n8n-docs/wiki/Styles/) for a quickstart, and guidance on style linting.
### n8n's license
## n8n's license
Be aware that n8n is fair code licensed. For more information, refer to the [License](https://docs.n8n.io/reference/license/) documentation.
@ -31,21 +50,7 @@ You need Git installed, and a GitHub account.
[Fork the documentation repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo).
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>
```
Then follow the instructions for external contributors in the [README](https://github.com/n8n-io/n8n-docs?tab=readme-ov-file#steps).
In GitHub, [create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) to merge the work from your fork to `main` in the docs repository.
@ -63,13 +68,14 @@ You can build the docs locally to preview them, or submit a pull request. All pu
For instructions on previewing the docs locally, refer to the [README](https://github.com/n8n-io/n8n-docs/blob/main/README.md).
### General checklist
## General checklist
Before submitting a PR, make sure your contribution ticks all these boxes:
- [ ] All necessary files and images are included.
- [ ] All formatting follows the [style guide](https://github.com/n8n-io/n8n-docs/wiki/Styles).
- [ ] All images are optimized.
- [ ] 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](https://github.com/n8n-io/n8n-docs/blob/master/CODE_OF_CONDUCT.md) and [contributor license agreement](https://github.com/n8n-io/n8n-docs/blob/master/CONTRIBUTOR_LICENSE_AGREEMENT.md).