Skip to content

Commit 6c90bdd

Browse files
committed
Exclude published RFCs from automated checks
The development and maintenance of the contents of this repository is facilitated by the use of tools, both locally by the contributor, and automatically on relevant changes by the continuous integration system. New issues may be detected by updating to a new version of a tool, or improving its configuration. In the case where this is in a published RFC, it is difficult to know how to proceed. Although a new revision may be created, standard practice is to not modify published RFCs. Creation of a new revision would not be appropriate for a minor typo or formatting fix. For this reason, the best approach will be to configure the tools to ignore the published RFCs. The exception is the link check, since we may be able to fix broken links to pages controlled by Arduino (e.g., by setting up external redirects).
1 parent 8c1a991 commit 6c90bdd

File tree

4 files changed

+18
-2
lines changed

4 files changed

+18
-2
lines changed

.codespellrc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[codespell]
44
# In the event of a false positive, add the problematic word, in all lowercase, to a comma-separated list here:
55
ignore-words-list = ,
6-
skip = ./.git,./go.mod,./go.sum,./package-lock.json,./poetry.lock,./yarn.lock
6+
skip = ./.git,./go.mod,./go.sum,./package-lock.json,./poetry.lock,./yarn.lock,./RFCs/0002-pluggable-discovery.md,./RFCs/0003-build-profiles.md,./RFCs/0004-pluggable-monitor.md
77
builtin = clear,informal,en-GB_to_en-US
88
check-filenames =
99
check-hidden =

.ecrc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
{
22
"Exclude": [
33
"^LICENSE\\.txt$",
4-
"^poetry\\.lock$"
4+
"^poetry\\.lock$",
5+
"^RFCs/0002-pluggable-discovery.md",
6+
"^RFCs/0003-build-profiles.md",
7+
"^RFCs/0004-pluggable-monitor.md"
58
]
69
}

.markdownlintignore

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-markdown/.markdownlintignore
2+
.licenses/
3+
__pycache__/
4+
node_modules/
5+
/RFCs/0002-pluggable-discovery.md
6+
/RFCs/0003-build-profiles.md
7+
/RFCs/0004-pluggable-monitor.md

.prettierignore

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
.licenses/
2+
__pycache__/
3+
node_modules/
4+
/RFCs/0002-pluggable-discovery.md
5+
/RFCs/0003-build-profiles.md
6+
/RFCs/0004-pluggable-monitor.md

0 commit comments

Comments
 (0)