You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -180,7 +180,7 @@ Adding a new security check for your feature is easy and fast:
180
180
newCheck({
181
181
title:'Door locked',
182
182
warning:'Anyone can enter your house.',
183
-
solution:'Lock your door.',
183
+
solution:'Lock the door.',
184
184
check: () => {
185
185
return; // Example of a passing check
186
186
}
@@ -207,11 +207,11 @@ Adding a new security check for your feature is easy and fast:
207
207
#### Wording Guideline
208
208
Consider the following when adding a newsecurity check:
209
209
-*Group.name*: The category name; ends without period as this is a headline.
210
-
-*Check.title*: Is the positive hypothesis that should be checked (for example "Door locked" instead of"Door unlocked"); ends without period as this is a title.
210
+
-*Check.title*: Is the positive hypothesis that should be checked, for example "Door locked" instead of"Door unlocked"; ends without period as this is a title.
211
211
-*Check.warning*: The warning if the test fails; ends with period as this is a description.
212
212
-*Check.solution*: The recommended solution if the test fails; ends with period as this is an instruction.
213
213
- The wordings must not contain any sensitive information such as keys, as the security report may be exposed in logs.
214
-
- The wordings should be concise and not contain verbose explanations.
214
+
- The wordings should be concise and not contain verbose explanations, for example "Door locked" instead of"Door has been locked securely".
215
215
- Do not use pronouns such as "you" or "your" because log files can have various readers with different roles. Do not use pronouns such as "I" or "me" because although we love it dearly, Parse Server is not a human.
0 commit comments