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

Merge pull request #10236 from raisedadead/fix/contributing-to-fcc

Browse Source 
fix(contributing-guide): Update guidelines
This commit is contained in:
Eric Leung
2016-08-16 09:59:06 -07:00
committed by GitHub
parent da73a7877b 95db97599f
commit 8d4b8c539e
1 changed files with 16 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
CONTRIBUTING.md
View File

@ -107,13 +107,8 @@ Edit your `.env` file and modify the API keys only for services that you will
use. use.
Note : Not all keys are required, to run the app locally, however `MONGOHQ_URL` Note : Not all keys are required, to run the app locally, however `MONGOHQ_URL`
is the most important one. is the most important one. Unless you have MongoDB running in a setup different
than the defaults, the URL in the `sample.env` should work fine.
If you only use email login, in addition to `MONGOHQ_URL`, `SESSION_SECRET`, add
the `MANDRILL_USER` and `MANDRILL_PASSWORD` API Keys. Not setting these keys
will throw an exception when you sign up which you can ignore, you will still be
able to login, however you may get these keys
[here](https://www.mandrill.com/signup/). Sign up and create a new pair of keys.
You can leave the other keys as they are. Keep in mind if you want to use more You can leave the other keys as they are. Keep in mind if you want to use more
services you'll have to get your own API keys for those services and edit those services you'll have to get your own API keys for those services and edit those
@ -178,12 +173,14 @@ accepted by Free Code Camp proper.
Free Code Camp Issue Mods and staff are on hand to assist with Pull Request Free Code Camp Issue Mods and staff are on hand to assist with Pull Request
related issues on our Help Contributors Chat Room related issues on our Help Contributors Chat Room
#### Methods #### How to find the code in the Free Code Camp codebase to fix/edit?
There are two methods of creating a Pull for Free Code Camp: The best way to find out any code you wish to change/add or remove is using
the GitHub search bar at the top of the repository page. For example, you could
- Editing files via the GitHub Interface search for a challenge name and the results will display all the files along
- Editing files on a local clone with line numbers. Then you can proceed to the files and verify this is the area
that you were looking forward to edit. Always feel free to reach out to the chat
room when you are not certain of any thing specific in the code.
#### Important: ALWAYS EDIT ON A BRANCH #### Important: ALWAYS EDIT ON A BRANCH
@ -193,6 +190,13 @@ files. This is critical, because if your PR is not accepted, your copy of
staging will be forever sullied and the only way to fix it is to delete your staging will be forever sullied and the only way to fix it is to delete your
fork and re-fork. fork and re-fork.
#### Methods
There are two methods of creating a pull request for Free Code Camp:
- Editing files via the GitHub Interface
- Editing files on a local clone
##### Method 1: Editing via your Local Fork _(Recommended)_ ##### Method 1: Editing via your Local Fork _(Recommended)_
This is the recommended method. Read about How to Setup and Maintain a Local This is the recommended method. Read about How to Setup and Maintain a Local