Skip to content

Commit 43e6ec2

Browse files
authored
Merge pull request #70 from riscv/kersten1-patch-1
Update vale.adoc
2 parents 04433ad + 48bb84c commit 43e6ec2

File tree

1 file changed

+109
-0
lines changed

1 file changed

+109
-0
lines changed

src/vale.adoc

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,112 @@ Some of the errors that the AsciiDoc rules highlight include:
2424

2525
The RISC-V style for Vale enforces the rules that are set by the RISC-V style guidelines.
2626

27+
=== Abbreviations
28+
29+
Do not use punctuation in abbreviations. For example, IBM does not contain any periods.
30+
31+
////
32+
33+
=== Anthropomorphism
34+
35+
Anthropomorphism is granting abilities to inanimate objects, such as "This code allows you to enable access." Instead, make the user the focus of the sentence: "You can use this code to enable access."
36+
37+
=== Camel case
38+
39+
If you are using camel case (`camelCase`), consider using backticks.
40+
41+
////
42+
43+
=== Case sensitive terms
44+
45+
Terms such as "RISC-V" and "GitHub" are case sensitive. If your usage is in code, then be sure to place back ticks around the code phrase.
46+
47+
=== Conjunctions
48+
49+
Do not overuse conjunctions ("and", "but", "or", "so") when you begin a sentence.
50+
51+
* And
52+
* But
53+
54+
=== Contractions
55+
56+
Avoid using contractions in your documentation. Contractions can cause ambiguity with translations. You don't have to avoid them completely though.
57+
58+
=== Ellipses
59+
60+
Avoid ellipses (...) to indicated omitted words. Instead, spell out the complete phrase or use words such as "and so on" to indicate that a list is not complete.
61+
62+
=== Em dashes
63+
64+
Avoid em dashes. An em dash -- so called because it is the length of an English capital M -- sets off a comment in your text. Instead, use commas, parenthesis, or colons.
65+
66+
=== First person
67+
68+
Do not use words such as "I" or "we", unless you are indeed speaking on behalf of all of RISC-V International.
69+
70+
=== Friendly terminology
71+
72+
It is RISC-V policy to use modern word choices for terminology that is friendly for everyone. See [Friendly Terminology](https://lf-riscv.atlassian.net/wiki/spaces/TAXX/pages/565510188/Friendly+Terminology) technical process for more information.
73+
74+
=== Gender neutral language
75+
76+
Avoid using language that specifies a gender, such as "he" or "woman". Instead, use words such as "the author" or "human".
77+
78+
=== Heading punctuation
79+
80+
Do not use punctuation in headings.
81+
82+
////
83+
84+
=== Heading
85+
86+
Headings use Title case: all nouns, verbs, adjectives, and adverbs are capitalized. Do not capitalize conjunctions, prepositions, or articles.
87+
88+
=== Hyphens
89+
90+
Do not use hyphens unless that usage is approved. See Spelling.
91+
92+
////
93+
94+
=== Merge conflict markers
95+
96+
Do not include any Git merge conflict markers in your source text. For example, `<<<<<<< HEAD`.
97+
98+
=== Oxford comma
99+
100+
Use the Oxford comma. It saves lives.
101+
102+
////
103+
104+
=== Pascal case
105+
106+
If you are using Pascal case (`PascalCase`), consider using backticks.
107+
108+
////
109+
110+
=== Repeated words
111+
112+
Words such as "the" or "and" can end up duplicated in text.
113+
114+
=== Sentence length
115+
116+
Try to keep sentences to an average of 32 words or fewer, and vary sentence lengths.
117+
118+
=== Slash
119+
120+
Rather than use a slash, use either "or" or "and".
121+
122+
=== Spacing
123+
124+
Use one space between words and after the end of sentences.
125+
126+
=== Spelling
127+
128+
The dictionary chosen for RISC-V International specification writing is Webster's New College dictionary. You can find it online at https://www.yourdictionary.com/about/websters-new-world-college-dictionary.html[Webster's New World College Dictionary].
129+
130+
RISC-V International works with cutting edge technology and new words are to be expected. If you want to use a word that is not found in the Dictionary, you must first create an issue in the https://github.com/riscv-admin/riscv-vale/[Vale GitHub] repository. Your issue will be discussed at the Doc-Sig meeting. Please include the rationale for why your term should be included as well as any definitions that your term requires. If approved, your term will be added to the spelling exception list as well as to the https://github.com/riscv/riscv-glossary[RISC-V glossary].
131+
132+
=== Using
133+
134+
To avoid ambiguity, replace "using" with either "by using" or "that uses". Do not use articles and prepositions that can increase the clarity of a sentence.
135+

0 commit comments

Comments
 (0)