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

feat(dev): Update CONTRIBUTING

Browse Source
This commit is contained in:
Stuart Taylor
2017-12-16 10:13:08 +00:00
parent 01b47984c7
commit 3c4f7b6a15
1 changed files with 29 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
CONTRIBUTING.md
View File

@ -108,32 +108,32 @@ Do this prior to every time you create a branch for a PR:
1. Make sure you are on the `staging` branch 1. Make sure you are on the `staging` branch
```shell ```shell
$ git status $ git status
On branch staging On branch staging
Your branch is up-to-date with 'origin/staging'. Your branch is up-to-date with 'origin/staging'.
``` ```
If your aren't on `staging`, resolve outstanding files / commits and checkout the `staging` branch If your aren't on `staging`, resolve outstanding files / commits and checkout the `staging` branch
```shell ```shell
$ git checkout staging $ git checkout staging
``` ```
2. Do a pull with rebase against `upstream` 2. Do a pull with rebase against `upstream`
```shell ```shell
$ git pull --rebase upstream staging $ git pull --rebase upstream staging
``` ```
This will pull down all of the changes to the official staging branch, without making an additional commit in your local repo. This will pull down all of the changes to the official staging branch, without making an additional commit in your local repo.
3. (_Optional_) Force push your updated staging branch to your GitHub fork 3. (_Optional_) Force push your updated staging branch to your GitHub fork
```shell ```shell
$ git push origin staging --force $ git push origin staging --force
``` ```
This will overwrite the staging branch of your fork. This will overwrite the staging branch of your fork.
### Create A Branch ### Create A Branch
@ -173,8 +173,6 @@ Once you have freeCodeCamp cloned, before you start the application, you first n
# Install NPM dependencies # Install NPM dependencies
npm install npm install
# Install Gulp globally
npm install -g gulp
``` ```
Then you need to add the private environment variables (API Keys): Then you need to add the private environment variables (API Keys):
@ -215,26 +213,26 @@ mongod
npm run only-once npm run only-once
# start the application # start the application
gulp npm run develop
``` ```
Now navigate to your browser and open Now navigate to your browser and open
<http://localhost:3000>. If the app loads, <http://localhost:3000>. If the app loads,
congratulations – you're all set. Otherwise, let us know by asking in the [Contributors chat room](https://gitter.im/FreeCodeCamp/Contributors) on Gitter. There also might be an error in the console of your browser or in Bash / Terminal / Command Line that will help identify the problem. If the app launches but you are encountering errors with the UI itself, for example if fonts are not being loaded or if the code editor is not displaying properly, you may try the following: congratulations – you're all set. Otherwise, let us know by asking in the [Contributors chat room](https://gitter.im/FreeCodeCamp/Contributors) on Gitter. There also might be an error in the console of your browser or in Bash / Terminal / Command Line that will help identify the problem. If the app launches but you are encountering errors with the UI itself, for example if fonts are not being loaded or if the code editor is not displaying properly, you may try the following:
```bash ```bash
# Remove all installed node modules # Remove all installed node modules
rm -rf node_modules rm -rf node_modules
# Reinstall npm packages # Reinstall npm packages
npm install npm install
# Seed the database (optional) # Seed the database (optional)
node seed node seed
# Re-start the application # Re-start the application
gulp npm run develop
``` ```
### Make Changes ### Make Changes
This bit is up to you! This bit is up to you!