Commit b255e66

committed

Print instructions for false positive resolution when spell check fails

The assets include infrastructure to check for commonly misspelled words in the project files. Although the system is designed to reduce the incidence of false positives, they are still relatively common. For this reason, it is important to clearly communicate to the contributor how such false positives can be resolved. This can be accomplished effectively by printing instructions when the spell check fails. In order to avoid excessive verbosity of the output (note that the failure could just as well be a true positive), the description of the procedure is maintained in the asset documentation and the output message simply provides the URL of that documentation.

1 parent f5d2043 commit b255e66Copy full SHA for b255e66

File tree

1 file changed

+10

-1

lines changed

Taskfile.yml

1 file changed

+10

-1

lines changed

`‎Taskfile.yml‎`

Lines changed: 10 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -237,7 +237,16 @@ tasks:`
`237`	`237`	`vars:`
`238`	`238`	`POETRY_GROUPS: dev`
`239`	`239`	`cmds:`
`240`		`- - poetry run codespell`
	`240`	`+ - \|`
	`241`	`+ if`
	`242`	`+ ! poetry run \`
	`243`	`+ codespell`
	`244`	`+ then`
	`245`	`+ echo`
	`246`	`+ echo "If this was a false positive, add the word to the ignore list:"`
	`247`	`+ echo "https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/spell-check-task.md#false-positives"`
	`248`	`+ exit 1`
	`249`	`+ fi`
`241`	`250`
`242`	`251`	`# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/spell-check-task/Taskfile.yml`
`243`	`252`	`general:correct-spelling:`

0 commit comments

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Commit b255e66

File tree

1 file changed

1 file changed

`‎Taskfile.yml‎`

0 commit comments