Skip to content

Commit da45661

Browse files
StaticRocketpraneethbajjuri
authored andcommitted
ci(vale): switch style dir, add vocab
Use the recommended config directories for the official workflow [1]. Add a vocab accept list for some common terms I see currently being flagged. This will need to be extended. [1] https://github.com/errata-ai/vale-action?tab=readme-ov-file#repository-structure Signed-off-by: Randolph Sapp <[email protected]>
1 parent 6d4118c commit da45661

File tree

5 files changed

+52
-1
lines changed

5 files changed

+52
-1
lines changed
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
BeagleBone
2+
Broadcom
3+
GStreamer
4+
Jacinto
5+
Khronos
6+
OpenCL
7+
OpenGL
8+
OpenVX
9+
PVRCarbon
10+
PVRTune
11+
Sitara
12+
UniFlash
13+
Vulkan
14+
Yocto
15+
Zink
16+
[Cc]odec
17+
[Dd]unfell
18+
[Ee]thernet
19+
[Ff]ramebuffer
20+
[Kk]irkstone
21+
[Mm]ulticast
22+
[Ss]carthgap
23+
[Tt]oolchain
24+
balenaEtcher

.github/styles/config/vocabularies/PSDK/reject.txt

Whitespace-only changes.

.gitignore

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1+
# python artifacts
12
*.swp
23
*.pyc
4+
5+
# build artifacts
36
build/
4-
.vale/
7+
8+
# vale configs and intermediary data
9+
.github/styles/*
10+
!.github/styles/config

.vale.ini

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
1+
StylesPath = .github/styles
12
MinAlertLevel = suggestion
23

34
Packages = RedHat
45

6+
Vocab = PSDK
7+
58
[*.{md,rst}]
69
BasedOnStyles = RedHat
10+
RedHat.PascalCamelCase = NO
11+
RedHat.GitLinks = NO

CONTRIBUTING.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,22 @@ Copyright (C) 2024 Texas Instruments Incorporated - https://www.ti.com
180180
All other files inherit the generic CC-BY-SA-4.0 license and do not require an
181181
explicit license / copyright notice.
182182

183+
## Vale grammar, spelling and prose checking
184+
185+
This project currently uses [Vale](https://vale.sh/) for grammar spelling and
186+
prose checking. We operate on a loose version of [Red Hat's documentation style
187+
guidelines](https://github.com/redhat-documentation/vale-at-red-hat).
188+
189+
If there are words it detects as misspellings, add those words to the custom
190+
vocabulary entry in
191+
[accept.txt](.github/styles/config/vocabularies/PSDK/accept.txt). If there are
192+
words you see that you think do not constitute usage here, add those words to
193+
the [reject.txt](.github/styles/config/vocabularies/PSDK/reject.txt). Ensure the
194+
contents of these files are alphabetically sorted after any modifications.
195+
196+
Information about the formatting of these files is available
197+
[upstream](https://vale.sh/docs/keys/vocab#file-format).
198+
183199
## Fighting workflows
184200

185201
The workflows are here to help, but occasionally they can raise false positives.

0 commit comments

Comments
 (0)