fix(docs): modified grammar and phrasing in docs and comments (#43682)

* docs: fixed minor typos in how-to-open-a-pull-request.md

* docs: grammar fixes in FAQ.md

* refactor: streamlined comments in multiple TS files

* fix: linting issues
This commit is contained in:
Eric Cheng
2021-10-02 18:43:14 -04:00
committed by GitHub
parent da9725acd4
commit 1f880a552d
5 changed files with 10 additions and 8 deletions

View File

@ -4,7 +4,7 @@ type CreateTypesType = {
/**
* Creates an object in which the `keys` represent the action names and the
* `values` the action type.
* `values` represent the action type.
* {
* action: actionType,
* ...

View File

@ -8,7 +8,7 @@ const removeCssComments = (str: string): string =>
str.replace(/\/\*[\s\S]+?\*\//g, '');
export const removeJSComments = (codeStr: string): string => {
// TODO: publish type declarations and reenable eslint
// TODO: publish type declarations and re-enable eslint
try {
// eslint-disable-next-line @typescript-eslint/no-unsafe-call
return strip(codeStr) as string;

View File

@ -1,6 +1,8 @@
// These regex are not for validation, it is purely to see
// if we are looking at something like what we want to validate
// before we try to validate
/*
* This regex is not for validation, it is purely to see
* if we are looking at something like what we want to validate
* before we try to validate.
*/
export const maybeEmailRE = /.*@.*\.\w\w/;
export const maybeUrlRE = /https?:\/\/.*\..*/;
export const hasProtocolRE = /^http/;

View File

@ -6,7 +6,7 @@ Read our ["How to Contribute to Open Source Guide"](https://github.com/freeCodeC
Yes - You can contribute to any of the 30+ languages we have enabled on our translation platform.
We have the user contributed translations live in Chinese (中文) and Spanish (Español). We intend to localize freeCodeCamp into several major world languages. You can read all about this in our [announcement here](https://www.freecodecamp.org/news/world-language-translation-effort).
We have user-contributed translations live in Chinese (中文) and Spanish (Español). We intend to localize freeCodeCamp into several major world languages. You can read all about this in our [announcement here](https://www.freecodecamp.org/news/world-language-translation-effort).
If you are interested in contributing to translations please makes sure you [read this guide](how-to-translate-files.md) first.
@ -24,7 +24,7 @@ Please don't create GitHub issues for security issues. Instead, please send an e
### I am a student. Can I work on a feature for academic credits?
Yes. Please note we are unable to commit to any timelines or paperwork that may be a requirement by your college or university. We receive many pull-requests and code contributions by volunteer developers, and we respect their time and efforts. Out of respect for all of our other contributors, we will not give any PR special priority just because it happens to be school-related.
Yes. Please note we are unable to commit to any timelines or paperwork that may be a requirement by your college or university. We receive many pull-requests and code contributions from volunteer developers, and we respect their time and efforts. Out of respect for all of our other contributors, we will not give any PR special priority just because it happens to be school-related.
We request you to plan ahead and work on code contributions with this in mind.

View File

@ -87,7 +87,7 @@ And as always, feel free to ask questions on the ['Contributors' category on our
Conflicts can arise because many contributors work on the repository, and changes can break your PR which is pending a review and merge.
More often than not you may not require a rebase, because we squash all commits, however if a rebase is requested here is what you should do.
More often than not you may not require a rebase, because we squash all commits, however, if a rebase is requested, here is what you should do.
### For usual bug fixes and features