diff --git a/docs/authors-analytics-manual.md b/docs/authors-analytics-manual.md index 221ca725cd9..fa5bbe46392 100644 --- a/docs/authors-analytics-manual.md +++ b/docs/authors-analytics-manual.md @@ -1,10 +1,10 @@ # Authors Analytics Manual -If you are an author with access to the publication's Google Analytics Property (News), you can use this guide to view your articles engagement and search for articles by publication language. +If you are an author with access to the publication's Google Analytics Property (News), you can use this guide to view your article engagement and search for articles by publication language. ## Search by Language -To search for engagement reports by a specific language: +To search for engagement reports in a specific language: ![Image - Show steps to search by language on googla analytics](https://contribute.freecodecamp.org/images/google-analytics/search-by-language.png) diff --git a/docs/codebase-best-practices.md b/docs/codebase-best-practices.md index d7d1175e68d..9186622807e 100644 --- a/docs/codebase-best-practices.md +++ b/docs/codebase-best-practices.md @@ -162,7 +162,7 @@ The `api/` tests are split into two parts: Unit tests isolate a single function or component. The tests do not need mocking, but will require fixtures. -The unit tests are located in a new file adjacent the file exporting that being tested: +The unit tests are located in a new file adjacent to the file exporting that is being tested: ```text api/ diff --git a/docs/how-to-catch-outgoing-emails-locally.md b/docs/how-to-catch-outgoing-emails-locally.md index d1b5d21d0b0..f5532f1c7d4 100644 --- a/docs/how-to-catch-outgoing-emails-locally.md +++ b/docs/how-to-catch-outgoing-emails-locally.md @@ -104,7 +104,7 @@ Start [using MailHog](#using-mailhog). ## Using MailHog -Open a new browser tab or window and navigate to [http://localhost:8025](http://localhost:8025) to open your MailHog inbox when the MailHog installation has completed and MailHog is running. +Open a new browser tab or window and navigate to [http://localhost:8025](http://localhost:8025) to open your MailHog inbox when the MailHog installation has been completed and MailHog is running. ## Useful Links diff --git a/docs/how-to-contribute-to-the-codebase.md b/docs/how-to-contribute-to-the-codebase.md index b0fc5afe1ef..382894f0f6b 100644 --- a/docs/how-to-contribute-to-the-codebase.md +++ b/docs/how-to-contribute-to-the-codebase.md @@ -23,7 +23,7 @@ Follow these steps: nothing to commit, working directory clean ``` - If you got different message, then you aren't on main or your working directory isn't clean, resolve any outstanding files/commits and checkout `main`: + If you got a different message, then you aren't on main or your working directory isn't clean, resolve any outstanding files/commits and checkout `main`: ```console git checkout main @@ -56,7 +56,7 @@ Follow these steps: git push origin main --force ``` - You can validate your current main matches the upstream/main by performing a diff: + You can validate that your current main matches the upstream/main by performing a diff: ```console git diff upstream/main diff --git a/docs/how-to-enable-new-languages.md b/docs/how-to-enable-new-languages.md index ba3375c27eb..214e42fa40d 100644 --- a/docs/how-to-enable-new-languages.md +++ b/docs/how-to-enable-new-languages.md @@ -144,7 +144,7 @@ export const rtlLangs = ['']; ### Set Translated SuperBlocks -In the [shared/config/superblocks.ts](https://github.com/freeCodeCamp/freeCodeCamp/blob/main/shared/config/superblocks.ts) file, add the new language to the `notAuditedSuperBlocks` object. This lists all the superblocks which are not fully translated. Add an array of superblocks which have not been fully translated to it. For example: +In the [shared/config/superblocks.ts](https://github.com/freeCodeCamp/freeCodeCamp/blob/main/shared/config/superblocks.ts) file, add the new language to the `notAuditedSuperBlocks` object. This lists all the superblocks which are not fully translated. Add an array of superblocks that have not been fully translated to it. For example: ```js export const notAuditedSuperBlocks: NotAuditedSuperBlocks = { @@ -168,7 +168,7 @@ export const notAuditedSuperBlocks: NotAuditedSuperBlocks = { } ``` -Be sure to only add the superblocks which are **not** fully translated and approved. The translated superblocks will be calculated from this object. When a new superblock is finished being fully translated, remove it from the array for that language. +Be sure to only add the superblocks that are **not** fully translated and approved. The translated superblocks will be calculated from this object. When a new superblock is finished being fully translated, remove it from the array for that language. See the `SuperBlocks` enum at the beginning of the same file for the full list of superblocks. @@ -176,7 +176,7 @@ See the `SuperBlocks` enum at the beginning of the same file for the full list o Next, open the [`client/src/utils/algolia-locale-setup.ts`](https://github.com/freeCodeCamp/freeCodeCamp/blob/main/client/src/utils/algolia-locale-setup.ts) file. This data is used for the search bar that loads `/news` articles. While it is unlikely that you are going to test this functionality, missing the data for your language can lead to errors when attempting to build the codebase locally. -Add an object for your language to the `algoliaIndices` object. You should use the the same values as the `english` object for local testing, replacing the `english` key with your language's `availableLangs` value. +Add an object for your language to the `algoliaIndices` object. You should use the same values as the `english` object for local testing, replacing the `english` key with your language's `availableLangs` value. > [!NOTE] > If we have already deployed an instance of news in your target language, you can update the values to reflect the live instance. Otherwise, use the English values. @@ -232,7 +232,7 @@ You don't have to have everything in these 3 files translated at first. It's pos You can replace any URLs that you have corresponding pages ready in your language. -For example, if you have the publication in your language, you can replace the URL for `"news"`. If you want to translate articles listed in the footer links, see [How to Translate Articles in the Footer Links](language-lead-handbook.md#how-to-translate-articles-in-the-footer-links). +For example, if you have a publication in your language, you can replace the URL for `"news"`. If you want to translate articles listed in the footer links, see [How to Translate Articles in the Footer Links](language-lead-handbook.md#how-to-translate-articles-in-the-footer-links). #### `meta-tags.json` @@ -306,7 +306,7 @@ videoLocaleIds: Joi.when('challengeType', { If you would like to test translations locally, before adding them to our main repository - skip the Crowdin workflow changes. Follow the steps for enabling a language, then download the translations from Crowdin and load them into your local code. -Because the language has not been approved for production, our scripts are not automatically downloading the translations yet. Only staff have the access to directly download the translations - you are welcome to reach out to us in our [contributors chat room](https://discord.gg/PRyKn3Vbay), or you can translate the English markdown files locally for testing purposes. +Because the language has not been approved for production, our scripts are not automatically downloading the translations yet. Only staff have access to directly download the translations - you are welcome to reach out to us in our [contributors chat room](https://discord.gg/PRyKn3Vbay), or you can translate the English markdown files locally for testing purposes. Once you have the files, you will need to place them in the correct directory. For the curriculum challenges, you should place the certification folders (i.e. `01-responsive-web-design`) within the `curriculum/challenges/{lang}` directory. For our Dothraki translations, this would be `curriculum/challenges/dothraki`. The client translation `.json` files will go in the `client/i18n/locales/{lang}` directory. @@ -330,7 +330,7 @@ In [`shared/config/i18n.ts`](https://github.com/freeCodeCamp/freeCodeCamp/blob/m export const hiddenLangs = []; // Remove your language from the array ``` -When this PR is merged and gets deployed, the curriculum in your language will be live. +When this PR is merged and deployed, the curriculum in your language will be live. # Deploying New Languages on `/news` diff --git a/docs/how-to-help-with-video-challenges.md b/docs/how-to-help-with-video-challenges.md index 08cc84f19cd..7b8800ccfa0 100644 --- a/docs/how-to-help-with-video-challenges.md +++ b/docs/how-to-help-with-video-challenges.md @@ -127,7 +127,7 @@ Add/Update the question text under the part that shows: ## --text-- ``` -Add/Update answers (`Answer 1`, `Answer 2`, and so on) under `## --answers--`. Make sure to update the number under `## --video-solution--` with the correct answer number. You can add more possible answers using the same format. The question and answers can be surrounded with quotation marks. +Add/Update answers (`Answer 1`, `Answer 2`, and so on) under `## --answers--`. Make sure to update the number under `## --video-solution--` with the correct answer number. You can add more possible answers using the same format. The questions and answers can be surrounded with quotation marks. ### Question examples diff --git a/docs/how-to-open-a-pull-request.md b/docs/how-to-open-a-pull-request.md index 12594bb8681..5a745feaff1 100644 --- a/docs/how-to-open-a-pull-request.md +++ b/docs/how-to-open-a-pull-request.md @@ -143,7 +143,7 @@ When you are working on regular bugs and features on our development branch `mai ### For Upcoming Curriculum and Features -When you are working on features for our upcoming curriculum `next-*` branches, you have to do a cherry pick: +When you are working on features for our upcoming curriculum `next-*` branches, you have to do a `cherry-pick`: 1. Make sure your upstream comes in sync with your local: @@ -154,7 +154,7 @@ When you are working on features for our upcoming curriculum `next-*` branches, git reset --hard upstream/next-python-projects ``` -2. Take backup +2. Take a backup a. Either delete your local branch after taking a backup (if you still have it locally): @@ -172,7 +172,7 @@ When you are working on features for our upcoming curriculum `next-*` branches, git branch -D ``` - b. Or just a backup of your pr branch (if you do not have it locally): + b. Or just a backup of your PR branch (if you do not have it locally): ```console git checkout -b origin/ diff --git a/docs/how-to-proofread-files.md b/docs/how-to-proofread-files.md index b68b832e1e9..7554ef43d5e 100644 --- a/docs/how-to-proofread-files.md +++ b/docs/how-to-proofread-files.md @@ -2,7 +2,7 @@ Our proofreading team is responsible for ensuring that translations accurately reflect the source text. We trust our proofreaders to ensure that we have very high quality translations. -All our translations are done by hand, by real humans. Proofreading ensures that there is a consistent tone across our all our translated resources like the curriculum. +All our translations are done by hand, by real humans. Proofreading ensures that there is a consistent tone across all our translated resources like the curriculum. To begin proofreading, visit [our translation platform](https://translate.freecodecamp.org) and login. Select "Go to console" in the top navigation bar to switch from the public view to the workspace view. @@ -52,6 +52,6 @@ Our staff team and community moderators teams are always looking for kind volunt ## Creating a Channel on Chat for a World Language -For the most part we encourage you to use the [contributors chat](https://discord.gg/PRyKn3Vbay) room for all correspondence. However if the team of volunteer translators grows for a certain language, we can consider creating additional break-out channel for the language. +For the most part, we encourage you to use the [contributors chat](https://discord.gg/PRyKn3Vbay) room for all correspondence. However if the team of volunteer translators grows for a certain language, we can consider creating an additional break-out channel for the language. If you are already a proofreader and are interested in having a dedicated channel on our chat servers for a specific language, [fill out this form](https://forms.gle/XU5CyutrYCgDYaVZA). diff --git a/docs/how-to-setup-freecodecamp-locally.md b/docs/how-to-setup-freecodecamp-locally.md index c06645f9610..87b756c9adf 100644 --- a/docs/how-to-setup-freecodecamp-locally.md +++ b/docs/how-to-setup-freecodecamp-locally.md @@ -7,7 +7,7 @@ Follow these guidelines for setting up a development environment for freeCodeCam > - You can't use Windows Command Prompt, Git Bash or PowerShell to build and run the codebase. > - Note that if using Windows, the hardware requirements need to be more than [what we mention](how-to-setup-freecodecamp-locally?id=how-to-prepare-your-local-machine) to accommodate for WSL-based setup. -If you are looking to make a one-off contribution, you should use Gitpod to make changes. The Gitpod setup launches a ready-to-code environment in a few minutes in your web browser. For contributing long-term, we recommend you setup freeCodeCamp on your local machine. +If you are looking to make a one-off contribution, you should use Gitpod to make changes. The Gitpod setup launches a ready-to-code environment in a few minutes in your web browser. To contribute long-term, we recommend you set up freeCodeCamp on your local machine. Here are some pros and cons which should help you decide which option is best for you: @@ -22,9 +22,9 @@ Here are some pros and cons which should help you decide which option is best fo ### How to Prepare a Gitpod Workspace -We have automated the process of installing all the dependencies & tools you will need. With Gitpod you get a free ready-to-code environment in a few minutes, and is useful if you do not have access to computer or want to make one-time changes. +We have automated the process of installing all the dependencies & tools you will need. With Gitpod you get a free ready-to-code environment in a few minutes, and is useful if you do not have access to a computer or want to make one-time changes. -There are various ways to launch an Gitpod workspace: +There are various ways to launch a Gitpod workspace: 1. **(Fastest)** Prepend `gitpod.io/#` in front of any URL from GitHub. @@ -166,7 +166,7 @@ Now that you have downloaded a copy of your fork, you will need to set up an `up You need a reference from your local clone to the `upstream` repository in addition to the `origin` repository. This is so that you can sync changes from the main repository without the requirement of forking and cloning repeatedly. -1. Change directory to the new freeCodeCamp directory: +1. Change the directory to the new freeCodeCamp directory: ```console cd freeCodeCamp diff --git a/docs/how-to-setup-freecodecamp-mobile-app-locally.md b/docs/how-to-setup-freecodecamp-mobile-app-locally.md index 10651072ad7..70c3a87166f 100644 --- a/docs/how-to-setup-freecodecamp-mobile-app-locally.md +++ b/docs/how-to-setup-freecodecamp-mobile-app-locally.md @@ -46,7 +46,7 @@ Once you have the prerequisites installed, you need to prepare your development [Forking](https://help.github.com/articles/about-forks/) is a step where you get your own copy of the repository (a.k.a _repo_) on GitHub. -This is essential, as it allows you to work on your own copy of freeCodeCamp mobile app on GitHub, or to download (clone) your repository to work on locally. Later, you will be able to request changes to be pulled into the main repository from your fork via a pull request (PR). +This is essential, as it allows you to work on your own copy of the freeCodeCamp mobile app on GitHub, or to download (clone) your repository to work on locally. Later, you will be able to request changes to be pulled into the main repository from your fork via a pull request (PR). > [!TIP] > The main repository at `https://github.com/freeCodeCamp/mobile` is often referred to as the `upstream` repository. @@ -368,14 +368,14 @@ Follow these steps: > [!NOTE] > You only need to follow this section if you're modifying the challenge test runner in the mobile app. Otherwise, you can go to the next section on [how to open a pull request](#proposing-a-pull-request-pr). -1. Clone a copy of the [freeCodeCamp repo](https://github.com/freeCodeCamp/freeCodeCamp) locally outside of your local copy of freeCodeCamp mobile repo. Your folder structure should look like this: +1. Clone a copy of the [freeCodeCamp repo](https://github.com/freeCodeCamp/freeCodeCamp) locally outside of your local copy of the freeCodeCamp mobile repo. Your folder structure should look like this: ```console ├── freeCodeCamp ├── mobile ``` -2. Change directory to the freeCodeCamp repo: +2. Change the directory to the freeCodeCamp repo: ```console cd freeCodeCamp @@ -487,7 +487,7 @@ If you are on a different OS and/or are still running into issues, see [getting ### Issues with the UI, build errors, etc. -If you face issues with the UI, or builds errors a cleanup can be useful: +If you face issues with the UI, or build errors a cleanup can be useful: ```console flutter clean @@ -495,7 +495,7 @@ flutter clean ### Issues Installing Dependencies -If you get errors while installing the dependencies, please make sure that you are not in a restricted network or your firewall settings do not prevent you from accessing resources. +If you get errors while installing the dependencies, please make sure that you are not in a restricted network or that your firewall settings do not prevent you from accessing resources. Be patient as the first-time setup can take a while depending on your network bandwidth. diff --git a/docs/how-to-setup-wsl.md b/docs/how-to-setup-wsl.md index 37e566b8c17..7ba30dbae31 100644 --- a/docs/how-to-setup-wsl.md +++ b/docs/how-to-setup-wsl.md @@ -124,7 +124,7 @@ Now that you have installed the pre-requisites, follow [our local setup guide](h > [!WARNING] > -> Please note, at this time the setup for Cypress tests (and related GUI needs) are a work in progress. You should still be able to work on most of the codebase. +> Please note, at this time the setup for Cypress tests (and related GUI needs) is a work in progress. You should still be able to work on most of the codebase. ## Useful Links diff --git a/docs/how-to-use-docker-on-windows-home.md b/docs/how-to-use-docker-on-windows-home.md index f091299dcd9..21438241f8d 100644 --- a/docs/how-to-use-docker-on-windows-home.md +++ b/docs/how-to-use-docker-on-windows-home.md @@ -2,7 +2,7 @@ There are a few pitfalls to be avoided when setting up Docker on Windows Home. First of all, you have to use [Docker Toolbox](https://docs.docker.com/toolbox/toolbox_install_windows/) as Administrator. Unfortunately Windows Home does not support Docker for Windows Desktop, so Toolbox must be used instead. It has to be run as Administrator as the installation uses symlinks, which cannot be created otherwise. -Once you've installed the toolbox, run Docker Quickstart Terminal as Administrator. This will create a `default` virtual machine if it does not already exist. Once that has happened, close the terminal and open VirtualBox (again as Administrator). You should be able to see the `default` machine. The site is quite resource-intensive, so stop the virtual machine and raise the settings as much as you can - memory in particular. It has been confirmed to work with 4GB of ram. +Once you've installed the toolbox, run Docker Quickstart Terminal as Administrator. This will create a `default` virtual machine if it does not already exist. Once that has happened, close the terminal and open VirtualBox (again as Administrator). You should be able to see the `default` machine. The site is quite resource-intensive, so stop the virtual machine and raise the settings as much as you can - memory in particular. It has been confirmed to work with 4GB of RAM. Once you're happy that Docker is working, clone the freeCodeCamp repository to a directory inside `C:\Users`. These directories are shared giving Docker access to the local directories, which it needs during installation. diff --git a/docs/how-to-work-on-coding-challenges.md b/docs/how-to-work-on-coding-challenges.md index d572f9f3286..5fdcf6adfad 100644 --- a/docs/how-to-work-on-coding-challenges.md +++ b/docs/how-to-work-on-coding-challenges.md @@ -4,7 +4,7 @@ Our goal is to develop a fun and clear interactive learning experience. Designing interactive coding challenges is difficult. It would be much easier to write a lengthy explanation or to create a video tutorial. But for our core curriculum, we're sticking with what works best for most people - a fully interactive, video game-like experience. -We want campers to achieve a flow state. We want them to build momentum and blast through our curriculum with as few snags as possible. We want them to go into the projects with confidence and gain a wide exposure to programming concepts. +We want campers to achieve a flow state. We want them to build momentum and blast through our curriculum with as few snags as possible. We want them to go into the projects with confidence and gain wide exposure to programming concepts. Note that for Version 7.0 of the freeCodeCamp curriculum, we are moving toward [an entirely project-focused model with a lot more repetition](https://www.freecodecamp.org/news/python-curriculum-is-live/). @@ -554,7 +554,7 @@ b c ``` -And you choose `b`, your new order will be: +If you choose `b`, your new order will be: ```bash a diff --git a/docs/how-to-work-on-localized-client-webapp.md b/docs/how-to-work-on-localized-client-webapp.md index fde3b75614a..fbc828e5ebc 100644 --- a/docs/how-to-work-on-localized-client-webapp.md +++ b/docs/how-to-work-on-localized-client-webapp.md @@ -9,13 +9,13 @@ Once you have set up the project locally you should be able to follow this docum This could be helpful when you are working on a feature that specifically targets something that involves localization, and requires you to validate for instance a button's label in a different language. > [!TIP] -> You do not need to follow this document for translating freeCodeCamp's curriculum or contributing documentation. Read [this guide here](how-to-translate-files.md) instead. +> You do not need to follow this document to translate freeCodeCamp's curriculum or contributing documentation. Read [this guide here](how-to-translate-files.md) instead. Let's understand how the i18n frameworks and tooling work. ## File Structure -Most of the files for translating the platform are located in the [`client/i18n`](https://github.com/freeCodeCamp/freeCodeCamp/tree/main/client/i18n) folder. Each language has a directory within that containing JSON files with the translations. +Most of the files for translating the platform are located in the [`client/i18n`](https://github.com/freeCodeCamp/freeCodeCamp/tree/main/client/i18n) folder. Each language has a directory that contains JSON files with the translations. ```console config @@ -56,7 +56,7 @@ Most of the files for translating the platform are located in the [`client/i18n` └── validate-keys.ts ``` -Some of these files are translated on our translation platform (Crowdin) and some are translated or created via PR's on GitHub. +Some of these files are translated on our translation platform (Crowdin) and some are translated or created via PRs on GitHub. **Files translated on our translation platform:** diff --git a/docs/how-to-work-on-practice-projects.md b/docs/how-to-work-on-practice-projects.md index f0caaf64b9f..e3a62924e56 100644 --- a/docs/how-to-work-on-practice-projects.md +++ b/docs/how-to-work-on-practice-projects.md @@ -38,7 +38,7 @@ Clicking this button will add a new step at the end of the project. This step wi #### Create Empty Steps -Enter the number of steps you want to add in the input. Then, clicking the button will create that many empty steps at the end of the project. +Enter the number of steps you want to add in the input. Then, clicking the button will create many empty steps at the end of the project. #### Insert Step @@ -124,7 +124,7 @@ pnpm run delete-step X # where X is the step number to be deleted. ### update-step-titles -A one-off script that automatically updates the frontmatter in a project's markdown files so that they are consistent with the project's meta.json. It ensures that each step's title (and dashedName) match the meta's challengeOrder. +A one-off script that automatically updates the frontmatter in a project's markdown files so that they are consistent with the project's meta.json. It ensures that each step's title (and dashedName) matches the meta's `challengeOrder`. #### How to Run the Script diff --git a/docs/how-to-work-on-tutorials-that-use-coderoad.md b/docs/how-to-work-on-tutorials-that-use-coderoad.md index e637181d565..2a7914277fb 100644 --- a/docs/how-to-work-on-tutorials-that-use-coderoad.md +++ b/docs/how-to-work-on-tutorials-that-use-coderoad.md @@ -56,7 +56,7 @@ If you want to test your changes to `main` after using the above instructions, f - Follow the instructions on the [rdb-alpha repo](https://github.com/freeCodeCamp/rdb-alpha) to run a container - Start the tutorial using the `tutorial.json` file on the new branch -### Reviewing PR's to `main` +### Reviewing PRs to `main` If reviewing a PR that only changes `main` with instructional or grammar issues as described above, the changes in `TUTORIAL.md` should match the changes in `tutorial.json`. @@ -119,11 +119,11 @@ If you have write access to the freeCodeCamp repo, have verified the `CHANGELOG` - Make a PR to `main` on the freeCodeCamp repo - If you are satisfied, merge it or leave it and ask for a review from someone - After the PR is merged, open the tutorial by following the instructions on the [rdb-alpha repo](https://github.com/freeCodeCamp/rdb-alpha) to make sure it's loading properly, and that you can get through a few steps -- Finally, if any PRs for this version exists, close them +- Finally, if any PRs for this version exist, close them ### How to Revert to a Previous Version -- Create a new branch off the latest `main` with `git checkout -b revert/to-version-X.X.X` +- Create a new branch off of the latest `main` with `git checkout -b revert/to-version-X.X.X` - Revert all commits on this branch up to and including the commit of the version after the one you want to revert to. For example, you may have commits that look like this: ``` diff --git a/docs/language-lead-handbook.md b/docs/language-lead-handbook.md index 38b2bbdd5e0..973e0149bf0 100644 --- a/docs/language-lead-handbook.md +++ b/docs/language-lead-handbook.md @@ -352,7 +352,7 @@ In Crowdin, individuate the `User management` on the left-hand side menu. This will open the user management tools, you will be able to see the list of all the users. -Search for the user that will become a proofreader. Use the three dots menu on the user row to open a menu and select "Add to team". The proofreader teams have a standard name of `Proof Readers ()`, you can search the team using the language name. Once you have selected the team, use the "ADD" button at the bottom of the page to finalize the thing. +Search for the user who will become a proofreader. Use the three dots menu on the user row to open a menu and select "Add to team". The proofreader teams have a standard name of `Proof Readers ()`, you can search the team using the language name. Once you have selected the team, use the "ADD" button at the bottom of the page to finalize the thing. The user is now a proofreader. diff --git a/docs/moderator-handbook.md b/docs/moderator-handbook.md index bde63ab5aa3..0b9ee4a1d2b 100644 --- a/docs/moderator-handbook.md +++ b/docs/moderator-handbook.md @@ -20,7 +20,7 @@ freeCodeCamp is an inclusive community, and we need to keep it that way. We have a single [Code of Conduct](https://code-of-conduct.freecodecamp.org) that governs our entire community. The fewer the rules, the easier they are to remember. You can read those rules and commit them to memory [here](https://code-of-conduct.freecodecamp.org). > [!NOTE] -> As a moderator, we would add you to one or more teams on GitHub, our community forums & chat servers. If you are missing access on a platform that you would like to moderate, please [reach out to a staff member](FAQ.md#additional-assistance). +> As a moderator, we would add you to one or more teams on GitHub, our community forums & chat servers. If you are missing access to a platform that you would like to moderate, please [reach out to a staff member](FAQ.md#additional-assistance). ## Moderating GitHub @@ -167,7 +167,7 @@ As a moderator, you help keep our community an enjoyable place for anyone to lea Note that once you are a moderator on the forum, you will start to see blue moderator hints about forum members, like "this is the first time [person] has posted - let's welcome them to the community!" or "[person] hasn't posted in a long time - let's welcome them back." -![A blue text message saying "this is the first time [person] has posted - let's welcome them to the community!](https://i.imgur.com/mPmVgzK.png) +![A blue text message saying "This is the first time [person] has posted - let's welcome them to the community!](https://i.imgur.com/mPmVgzK.png) These are opportunities for you to welcome them and make them feel extra special. You never know which person who's marginally involved may become our next super-helper, helping many other people in their coding journey. Even the slightest kindness may trigger a cascade of good deeds. diff --git a/docs/reply-templates.md b/docs/reply-templates.md index 830f4daad76..28be2dfdf4c 100644 --- a/docs/reply-templates.md +++ b/docs/reply-templates.md @@ -185,7 +185,7 @@ If the forum members determine there is nothing wrong with your code, you can re Thank you and happy coding. ``` -> When an issue is duplicate of an earlier issue. +> When an issue is a duplicate of an earlier issue. ```markdown Thank you for reporting this issue. @@ -232,7 +232,7 @@ Happy contributing. ```md We typically do not assign issues. Instead, we accept the first pull request that comprehensively solves the issue. -Issues labelled with `help wanted` or `first timers only` are open for contributions. +Issues labeled with `help wanted` or `first timers only` are open for contributions. Please make sure you read [our guidelines for contributing](https://contribute.freecodecamp.org/#/). We prioritize contributors following the instructions in our guide. Join us in [our chat room](https://discord.gg/PRyKn3Vbay) or [the forum](https://forum.freecodecamp.org/c/contributors/3) if you need help contributing - our community will be happy to assist you. ``` diff --git a/docs/troubleshooting-development-issues.md b/docs/troubleshooting-development-issues.md index 6b19123520f..f3cb1d502f0 100644 --- a/docs/troubleshooting-development-issues.md +++ b/docs/troubleshooting-development-issues.md @@ -31,7 +31,7 @@ Use the shortcut pnpm run clean-and-develop ``` -If you continue to face issues with the build, cleaning up the workspace is recommend. +If you continue to face issues with the build, cleaning up the workspace is recommended. Use `git clean` in interactive mode: @@ -49,7 +49,7 @@ git clean -ifdX ## Issues with API, login, Challenge Submissions, etc. -If you can't sign in, and instead you see a banner with an error message that it will be reported to freeCodeCamp, please double-check that your local port `3000` is not in use by a different program. +If you can't sign in, and instead you see a banner with an error message saying that the error will be reported to freeCodeCamp, please double-check that your local port `3000` is not in use by a different program. #### **From Terminal:** ```console