diff options
author | Daniel Stenberg <daniel@haxx.se> | 2021-10-31 16:34:44 +0100 |
---|---|---|
committer | Daniel Stenberg <daniel@haxx.se> | 2021-11-07 23:16:27 +0100 |
commit | a28464ae77c201ae29afc9dc9dc756b80a960d4c (patch) | |
tree | efcf174ba85a45906ac7bc4ede3d5d71d5f75d04 /docs/CODE_REVIEW.md | |
parent | d3d079c138e8abaedcb0c557bc466e69e6b79b1c (diff) | |
download | curl-a28464ae77c201ae29afc9dc9dc756b80a960d4c.tar.gz |
docs: reduce/avoid English contractions
You're => You are
Hasn't => Has not
Doesn't => Does not
Don't => Do not
You'll => You will
etc
Closes #7930
Diffstat (limited to 'docs/CODE_REVIEW.md')
-rw-r--r-- | docs/CODE_REVIEW.md | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/CODE_REVIEW.md b/docs/CODE_REVIEW.md index b18f4a607..20d1be849 100644 --- a/docs/CODE_REVIEW.md +++ b/docs/CODE_REVIEW.md @@ -43,10 +43,10 @@ as possible. ## Code style Most code style nits are detected by checksrc but not all. Only leave remarks -on style deviation once checksrc doesn't find anymore. +on style deviation once checksrc does not find anymore. Minor nits from fresh submitters can also be handled by the maintainer when -merging, in case it seems like the submitter isn't clear on what to do. We +merging, in case it seems like the submitter is not clear on what to do. We want to make the process fun and exciting for new contributors. ## Encourage consistency @@ -105,15 +105,15 @@ updated documentation. Submitting that in a separate follow-up pull request is not OK. A code review must also verify that the submitted documentation update matches the code submission. -English isn't everyone's first language, be mindful of this and help the +English is not everyone's first language, be mindful of this and help the submitter improve the text if it needs a rewrite to read better. -## Code shouldn't be hard to understand +## Code should not be hard to understand Source code should be written to maximize readability and be easy to understand. -## Functions shouldn't be large +## Functions should not be large A single function should never be large as that makes it hard to follow and understand all the exit points and state changes. Some existing functions in |