Skip to content

Commit

Permalink
improved wording guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
mtrezza committed Mar 10, 2021
1 parent 38bdda7 commit d9aeb73
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ Adding a new security check for your feature is easy and fast:
new Check({
title: 'Door locked',
warning: 'Anyone can enter your house.',
solution: 'Lock your door.',
solution: 'Lock the door.',
check: () => {
return; // Example of a passing check
}
Expand All @@ -207,11 +207,11 @@ Adding a new security check for your feature is easy and fast:
#### Wording Guideline
Consider the following when adding a new security check:
- *Group.name*: The category name; ends without period as this is a headline.
- *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.
- *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.
- *Check.warning*: The warning if the test fails; ends with period as this is a description.
- *Check.solution*: The recommended solution if the test fails; ends with period as this is an instruction.
- The wordings must not contain any sensitive information such as keys, as the security report may be exposed in logs.
- The wordings should be concise and not contain verbose explanations.
- The wordings should be concise and not contain verbose explanations, for example "Door locked" instead of "Door has been locked securely".
- 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.

### Parse Error
Expand Down

0 comments on commit d9aeb73

Please sign in to comment.