Skip to content

Commit 4133780

Browse files
authored
[DRAFT] Acrolinx config (#67)
1 parent 27aabd1 commit 4133780

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

acrolinx/global-config.edn

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
{
2+
:allowed-branchname-matches ["main"]
3+
:allowed-filename-matches ["docs/"] ;; Need to check if wildcards work. Separate multiple folders as follows ["folder/" "folder2"]
4+
:use-gh-statuses false
5+
:guidance-profile "a5004e01-d057-4190-86b2-ac1ed8a0dc8c" ;; Profile ID for "Elastic" (supplied by Acrolinx)
6+
:ignored-filetypes ["mod" "sum" "go" "txt"]
7+
8+
:template-header
9+
"
10+
11+
## Acrolinx Scorecards
12+
13+
Select the total score link to review all feedback on clarity, consistency, tone, brand, terms, spelling, grammar, readability, and inclusive language. _You should fix all spelling errors regardless of your total score_. Fixing spelling errors helps maintain user trust in overall content quality.
14+
15+
| Article | Total score<br>(Required: 80) | Words + phrases<br>(Brand, terms) | Correctness<br>(Spelling, grammar) | Clarity<br>(Readability) |
16+
|---------|:--------------:|:--------------------:|:------:|:---------:|
17+
"
18+
19+
:template-change
20+
"| ${s/status} ${s/file} | [${acrolinx/qualityscore}](${acrolinx/scorecard}) | ${acrolinx/scores/words_and_phrases} | ${acrolinx/scores/correctness} | ${acrolinx/scores/clarity} |
21+
"
22+
23+
:template-footer
24+
"
25+
**TBD*
26+
"
27+
}

0 commit comments

Comments
 (0)