Skip to content

Commit d9aeb73

Browse files
committed
improved wording guidelines
1 parent 38bdda7 commit d9aeb73

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

CONTRIBUTING.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ Adding a new security check for your feature is easy and fast:
180180
new Check({
181181
title: 'Door locked',
182182
warning: 'Anyone can enter your house.',
183-
solution: 'Lock your door.',
183+
solution: 'Lock the door.',
184184
check: () => {
185185
return; // Example of a passing check
186186
}
@@ -207,11 +207,11 @@ Adding a new security check for your feature is easy and fast:
207207
#### Wording Guideline
208208
Consider the following when adding a new security check:
209209
- *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.
211211
- *Check.warning*: The warning if the test fails; ends with period as this is a description.
212212
- *Check.solution*: The recommended solution if the test fails; ends with period as this is an instruction.
213213
- 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".
215215
- 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.
216216

217217
### Parse Error

0 commit comments

Comments
 (0)