jprdonnelly/freeCodeCamp
1
0
Fork 0
mirror of https://github.com/freeCodeCamp/freeCodeCamp.git synced 2026-04-10 13:00:59 -04:00
Code Issues Projects Releases Wiki Activity

docs: clean up some typos (#48867)

Browse Source
This commit is contained in:
Naomi Carrigan
2022-12-29 22:47:17 -08:00
committed by GitHub
parent b34cd69ce1
commit b768c642fb
2 changed files with 11 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/how-to-contribute-to-the-codebase.md
View File

@@ -163,14 +163,14 @@ Follow these steps:
feat: add link for article for alexa skills
```
Make a conventional commit message. This is a good practice As a developer, and you will be following standard practices.
Make a conventional commit message. This is a good practice as a developer, and you will be following standard practices.
Some examples of conventional commit messages are:
```md
fix: improve HTML step
fix: fix build scripts for Travis-CI
feat: add link article JavaScript hoisting
feat: add link to JavaScript hoisting article
docs: update contributing guidelines
```

24
docs/how-to-setup-freecodecamp-locally.md
View File

@@ -3,7 +3,7 @@ Follow these guidelines for setting up freeCodeCamp locally on your system. This
Some of these contribution workflows – like fixing bugs in the codebase or curriculum – need you to run freeCodeCamp locally on your computer.
> [!TIP]
> If you are not interested in setting up freeCodeCamp locally, consider using Gitpod. We have automated the process of installating all the dependencies & tools you will need.
> If you are not interested in setting up freeCodeCamp locally, consider using Gitpod. We have automated the process of installing all the dependencies & tools you will need.
>
> Continue reading this guide to learn more about using GitPod.
@@ -36,13 +36,13 @@ This is essential, as it allows you to work on your own copy of freeCodeCamp on
## Use a Local Machine or GitPod
Once you have forked the repository, choose one among the below. You can either use your own local machine or a GitPod-based workspace to work on the codebase.
Once you have forked the repository, you can either use your own local machine or a GitPod-based workspace to work on the codebase.
For contributing long-term, we recommend you setup freeCodeCamp on your local machine.
### How to prepare a GitPod workspace
We have automated the process of installating 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 computer or want to make one-time changes.
There are various ways to launch an GitPod workspace:
@@ -50,17 +50,11 @@ There are various ways to launch an GitPod workspace:
For example, if you visit your fork at `https://github.com/YOUR_USER_NAME/freeCodeCamp.git`, add `gitpod.io/#` in the front of the URL in the address bar and hit enter.
That is you can navigate to
```
gitpod.io/#https://github.com/YOUR_USER_NAME/freeCodeCamp.git
```
and you should see a workspace created for you. This works for any repository or pull-request on GitHub.
That is you can navigate to `gitpod.io/#https://github.com/YOUR_USER_NAME/freeCodeCamp.git` and you should see a workspace created for you. This works for any repository or pull-request on GitHub.
2. Alternatively install one of the below extentions for your browser.
2. Alternatively install one of the below extensions for your browser.
- [Chrome Webstore](https://chrome.google.com/webstore/detail/gitpod-always-ready-to-co/dodmmooeoklaejobgleioelladacbeki) - works with Chromimum-based browsers like Google Chrome, Brave, Edge, etc.
- [Chrome Webstore](https://chrome.google.com/webstore/detail/gitpod-always-ready-to-co/dodmmooeoklaejobgleioelladacbeki) - works with Chromium-based browsers like Google Chrome, Brave, Edge, etc.
- [Firefox Add-on](https://addons.mozilla.org/en-US/firefox/addon/gitpod) - Firefox
Once installed you will see a 'GitPod' button on every repository, pull-request, etc. as a handy shortcut to launch a workspace from there. See the extension page for details, screenshots, etc.
@@ -73,9 +67,9 @@ Start by installing the prerequisite software for your operating system.
We primarily support development on Linux and Unix-based systems. Our staff and community contributors regularly work with the codebase using tools installed on Ubuntu and macOS.
We also support Windows 10 via WSL2, which you can prepare by [reading this guide](how-to-setup-wsl.md).
We also support Windows 10 and 11 via WSL2, which you can prepare by [reading this guide](how-to-setup-wsl.md).
Some community members also develop on Windows 10 natively with Git for Windows (Git Bash), and other tools installed on Windows. We do not have official support for such a setup at this time, we recommend using WSL2 instead.
Some community members also develop on Windows natively with Git for Windows (Git Bash), and other tools installed on Windows. We do not have official support for such a setup at this time, we recommend using WSL2 instead.
#### Prerequisites:
@@ -125,7 +119,7 @@ Once you have the prerequisites installed, you need to prepare your development
> If you are working on a WSL2 Linux Distro, you might get performance and stability issues by running this project in a folder which is shared between Windows and WSL2 (e.g. `/mnt/c/Users/`).
> Therefore we recommend to clone this repo into a folder which is mainly used by your WSL2 Linux Distro and not directly shared with Windows (e.g. `~/PROJECTS/`).
>
> See [this GitHub Issue](https://github.com/freeCodeCamp/freeCodeCamp/issues/40632) for further Information about this problem.
> See [this GitHub Issue](https://github.com/freeCodeCamp/freeCodeCamp/issues/40632) for further information about this problem.
Run these commands on your local machine: