Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(style-guide): Added avoid contractions/possessives #26591

Merged
merged 3 commits into from
Feb 18, 2024
Merged

docs(style-guide): Added avoid contractions/possessives #26591

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
32b23c7
docs(style-guide): Added avoid contractions
kvanzuijlen Jan 11, 2024
ce9fdeb
docs(style-guide): Added missing blank line
kvanzuijlen Jan 11, 2024
30f2f38
Apply suggestions from code review
kvanzuijlen Jan 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions docs/development/style-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,32 @@ Second sentence on a new line.
And so on.
```

## Avoid contractions/possessives

Avoid:

```markdown
don't
won't
doesn't
shouldn't
kvanzuijlen marked this conversation as resolved.
Show resolved Hide resolved
wouldn't
manager's
file's
```
kvanzuijlen marked this conversation as resolved.
Show resolved Hide resolved

Do:

```markdown
do not
will not
does not
should not
would not
```

Avoid possessives like `manager's` or `file's`, if needed rewrite the sentence.
kvanzuijlen marked this conversation as resolved.
Show resolved Hide resolved

## Avoid manually ordering numbered lists

Avoid:
Expand Down