Skip to content

Commit 68d513b

Browse files
committed
Add more documentation about the reviewdog [vale] report that is generated
1 parent d23dda6 commit 68d513b

2 files changed

Lines changed: 8 additions & 1 deletion

File tree

.github/vale/Vocab/Base/accept.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,4 @@ Committer's
99
asciidoctor
1010
asciidoc
1111
Yonik
12+
reviewdog

docs/spell-and-style-checking.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,16 @@ This happens automatically, using GitHub Actions and this workflow [vale.yml](.g
4343

4444
Output looks like this:
4545

46-
![Screenshot 2023-08-02 at 22 41 08](https://github.com/InnerSourceCommons/InnerSourceLearningPath/assets/163029/8dda3c81-634c-48db-9a2f-3f216b717e97)
46+
![Example of inline annotation](https://github.com/InnerSourceCommons/InnerSourceLearningPath/assets/163029/8dda3c81-634c-48db-9a2f-3f216b717e97)
4747

4848
Note that this highlighting will only be done for any issues found in lines that were changed in the given Pull Request. The idea here is that a contributor should only have to review style issues in the content that they have added themselves.
4949

50+
If you (e.g. as a maintainer) want to see all potential issues that vale has found in any file that it checked, you should check the "Filtered Findings" in the **reviewdog [vale] report** that is generated automatically for any PR as well.
51+
52+
That report looks like this:
53+
54+
![Example of reviewdog \[vale\] report](https://github.com/InnerSourceCommons/InnerSourceLearningPath/assets/163029/c0a478ea-4f01-4d2b-87a4-9340761221b8)
55+
5056
You should only have to adapt the GitHub Actions workflow in [vale.yml](.github/workflows/vale.yml) when adding entirely new sections to the Learning Path.
5157

5258
## How to add exceptions to the spell checker?

0 commit comments

Comments
 (0)