@@ -4,69 +4,122 @@ Style guide defining wording, spelling, and other details regarding how DSNP ter
4
4
For more information about DSNP, visit [ dsnp.org] ( https://www.dsnp.org/ )
5
5
or [ DSNP on GitHub] ( https://github.com/LibertyDSNP/spec )
6
6
7
- ## Announcement
8
- Uppercase A
7
+ ## General rules
8
+ * Announcements specific to DSNP have initial caps. (i.e., Broadcast Announcement)
9
+ * Announcement Types also have initial caps.
10
+ * General words that aren't specific to DSNP are lowercase (i.e., announcement, batch, content hash).
11
+ * Attribute is lowercase except when combined with an announcement or a specific DSNP set type. (i.e., Attribute Set Announcement)
12
+
13
+ ## Activity Content
14
+ Uppercase A and C
15
+
16
+ ## announcement
17
+ Generally all lowercase
9
18
10
19
## Announcement Type
11
20
Uppercase A and T
12
21
13
- ## Batch
14
- Uppercase B
22
+ ## attribute
23
+ All lowercase
24
+
25
+ ## attribute sets
26
+ All lowercase
27
+
28
+ ## Attribute Set Announcement
29
+ Uppercase A, S and A
30
+
31
+ ## Attribute Set Type
32
+ Uppercase A, S and T
33
+
34
+ ## Attribute Set Value Document
35
+ Uppercase A, S, V and D
36
+
37
+ ## batch
38
+ All lowercase
15
39
16
40
## Batch Publication
17
41
Uppercase B and P
18
42
43
+ ## bloom filter
44
+ lowercase b and f
45
+
46
+ ## Broadcast Announcements
47
+ Uppercase B and A
48
+
19
49
## Code of Conduct
20
50
Uppercase C and C
21
51
22
52
## community
23
53
All lowercase
24
54
55
+ ## content announcement
56
+ All lowercase
57
+
58
+ ## Content Attribute Set
59
+
60
+ ## content hash
61
+ All lowercase
62
+
63
+ ## credential document
64
+ All lowercase
65
+
25
66
## Decentralized Social Networking Protocol (DSNP)
26
67
Spelled out fully first time it appears and then acronym thereafter. Avoid preceding with the word "the" and never follow with the word "protocol".
27
68
28
69
## development community
29
70
All lowercase
30
71
72
+ ## DSNP Announcements
73
+ Uppercase DSNP and A
74
+
31
75
## DSNP public social graph
32
76
All lowercase after acronym
33
77
34
78
## DSNP Batch Publications
35
79
Uppercase Acronym plus uppercase B and P
36
80
81
+ ## DSNP content
82
+ Uppercase acronym, lowercase c
83
+
37
84
## DSNP Content Hash
38
85
Uppercase Acronym plus uppercase C and H
39
86
87
+ ## DSNP Content URI
88
+ Uppercase D, C and URI
89
+
40
90
## DSNP graph
41
91
Only acronym is uppercase
42
92
43
93
## DSNP Identifiers
44
94
Uppercase Acronym plus uppercase I
45
95
46
- ## DSNP Identity
47
- Uppercase Acronym plus Uppercase I
96
+ ## DSNP identity
97
+ Uppercase Acronym lowercase i
48
98
49
99
## DSNP Id
50
- Short for DSNP Identity , Uppercase Acronym plus uppercase I
100
+ Short for DSNP identity , Uppercase Acronym lowercase when spelled out
51
101
52
102
## DSNP Protocol Scheme
53
103
Uppercase Acronym plus uppercase P and S
54
104
55
105
## DSNP Specification
56
106
Uppercase DSNP and S, avoid preceding with the word "the"
57
107
108
+ ## DSNP user
109
+ Uppercase DSNP and lowercase u
110
+
58
111
## DSNP User Id
59
112
Uppercase acronym, U and I, avoid preceding with the word "the"
60
113
61
114
## DSNP User URI
62
115
Uppercase Acronyms plus uppercase U
63
116
64
- ## End User
65
- Uppercase E and U
66
-
67
117
## Exclamation Marks
68
118
Should be avoided
69
119
120
+ ## External Content Attributes
121
+ Uppercase E, C and A
122
+
70
123
## Graph Change Announcements
71
124
Uppercase G, C and A.
72
125
Note: Graph Change Announcements and events have been migrated to use User Data Operations as of version 1.2.0.
@@ -78,9 +131,15 @@ Note: Graph Change Announcements and events have been migrated to use User Data
78
131
## InterPlanetary File System (IPFS)
79
132
Uppercase I, P, F and S. In the first instance, spell out followed by the acronym in parentheses. Use the acronym only thereafter.
80
133
134
+ ## issuer
135
+ All lower case
136
+
81
137
## MUST/MUST NOT
82
138
All Caps when defining rules for specification
83
139
140
+ ## on-demand credential
141
+ Hyphenated, all lower case
142
+
84
143
## Operation
85
144
Uppercase O when referring to spec-defined DSNP Operations
86
145
@@ -90,26 +149,70 @@ Always use
90
149
## Possessives
91
150
Making DSNP possessive should be avoided (e.g. DSNP’s)
92
151
152
+ ## Profile Announcement
153
+ Uppercase P and A
154
+
93
155
## Project Liberty
94
156
Uppercase P and L
95
157
158
+ ## public key
159
+ All lowercase
160
+
96
161
## public graph
97
162
All lowercase
98
163
164
+ ## Public Key Announcement
165
+ Uppercase P, K and A
166
+
99
167
## Reaction Announcement
100
168
Uppercase R and A
101
169
102
170
## Record
103
171
Uppercase R when referring to spec-defined DSNP State Change Records
104
172
173
+ ## Reply Announcements
174
+ Uppercase R and A
175
+
176
+ ## schema
177
+ All lowercase
178
+
105
179
## social network graph
106
180
All lowercase
107
181
108
182
## Team
109
183
Should not be used in context with DSNP
110
184
185
+ ## Tombstone Announcement
186
+ Uppercase T and A
187
+
188
+ ## User Attribute Set Announcement
189
+ Uppercase U, A, S and A
190
+
191
+ ## verifier
192
+ Lowercase v
193
+
194
+ ## Verifiable Credential
195
+ Uppercase V and C. Singular for one document/credential; plural when referring to the specification.
196
+ If followed by "document", that should be lowercase.
197
+
198
+ ## Verifiable Credential Schema
199
+ Uppercase V, C, S.
200
+ If followed by "document", that should be lowercase.
201
+
111
202
## Update Announcement
112
203
Uppercase U and A
113
204
205
+ ## user
206
+ All lowercase
207
+
208
+ ## User Attribute Set
209
+ Uppercase U, A and S
210
+
211
+ ## verifier
212
+ All lowercase
213
+
114
214
## We/Us/Our
115
215
Should not be used in context with Frequency
216
+
217
+ ## YES and no
218
+ When describing required items, use an all caps "YES", otherwise a lowercase "no".
0 commit comments