gaspersic/freeCodeCamp
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs(local): update sync instructions (#30982)

Browse Source 
* docs(local): update sync instructions

* docs: update the formating

* docs: remove space and comma
This commit is contained in:
mrugesh mohapatra 2018-11-17 16:54:09 +05:30 committed by Quincy Larson
parent 0f335a2fbc
commit 3345f603ac
1 changed files with 14 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -114,7 +114,7 @@ Start by installing these prerequisite software.
| Prerequisite | Version | Notes | | Prerequisite | Version | Notes |
| ------------------------------------------- | ------- | ----- | | ------------------------------------------- | ------- | ----- |
| [MongoDB Community Server](https://docs.mongodb.com/manual/administration/install-community/) | `3.6` | [Release Notes](https://docs.mongodb.com/manual/release-notes/), Note: We currently on `3.6`, an [upgrade is planned](https://github.com/freeCodeCamp/freeCodeCamp/issues/18275). | [MongoDB Community Server](https://docs.mongodb.com/manual/administration/install-community/) | `3.6` | [Release Notes](https://docs.mongodb.com/manual/release-notes/), Note: We currently on `3.6`, an [upgrade is planned](https://github.com/freeCodeCamp/freeCodeCamp/issues/18275).
| [Node.js](http://nodejs.org) | `8.x` | [LTS Schedule](https://github.com/nodejs/Release#release-schedule) | | [Node.js](http://nodejs.org) | `8.x` | [LTS Schedule](https://github.com/nodejs/Release#release-schedule), Note: We currently on `8.x`, an upgrade is planned to 10.x |
| npm (comes bundled with Node) | `6.x` | Does not have LTS releases, we use the version bundled with Node LTS | | npm (comes bundled with Node) | `6.x` | Does not have LTS releases, we use the version bundled with Node LTS |
**Important:** **Important:**
@ -250,15 +250,23 @@ Follow these steps:
git checkout master git checkout master
``` ```
2. Next, you would want to `rebase` from the `upstream`. 2. Next, you would want to **sync the lastest changes for `master` branch** from the main repository of freeCodeCamp.
This step **will sync the lastest changes** from the main repository of freeCodeCamp. Its important that you rebase as often as possible, to avoid conflicts later. **Note:** If you have any outstanding pull-request that you made from the `master` branch of your fork previously, you will lose them. You should get it merged by a moderator, prior following this. To avoid this, you should always work on a branch.
Its recommended that you do this as often as possible, to avoid conflicts later:
```shell ```shell
git pull --rebase upstream master git fetch upstream
``` ```
You can optionally push this branch back to your origin, to have a clean history on your fork on GitHub. Now, you want to do a hard reset with the copy on the freeCodeCamp master:
```shell
git reset --hard upstream/master
```
Push this branch back to your origin, to have a clean history on your fork on GitHub:
```shell ```shell
git push origin master --force git push origin master --force
@ -381,7 +389,7 @@ Follow these steps:
You can learn more about why you should use conventional commits [here](https://www.conventionalcommits.org/en/v1.0.0-beta.2/#why-use-conventional-commits). You can learn more about why you should use conventional commits [here](https://www.conventionalcommits.org/en/v1.0.0-beta.2/#why-use-conventional-commits).
9. If you realise that you need to edit a file or, update the commit message after making a commit you can do so after editing the files with: 9. If you realise that you need to edit a file or update the commit message after making a commit you can do so after editing the files with:
```shell ```shell
git commit --amend git commit --amend
@ -424,10 +432,6 @@ Follow these steps:
This is very important when you are making changes that are not copy editing markdown files. For example, changes to CSS or JavaScript code, etc. This is very important when you are making changes that are not copy editing markdown files. For example, changes to CSS or JavaScript code, etc.
## Get your PR accepted
## Getting Help ## Getting Help
If you are stuck, and need help, let us know by asking in the ['Contributors' category on our forum](https://www.freecodecamp.org/forum/c/contributors) or the [Contributors chat room](https://gitter.im/FreeCodeCamp/Contributors) on Gitter. If you are stuck, and need help, let us know by asking in the ['Contributors' category on our forum](https://www.freecodecamp.org/forum/c/contributors) or the [Contributors chat room](https://gitter.im/FreeCodeCamp/Contributors) on Gitter.