0ce461cbbd
* Fixed a broken link to the contributors forums * Grammar typo at the end There was a grammar typo - passive voice without "BE" |
||
|---|---|---|
| .. | ||
| arabic | ||
| chinese | ||
| german | ||
| images | ||
| italian | ||
| portuguese | ||
| romanian | ||
| russian | ||
| spanish | ||
| README.md | ||
| how-to-catch-outgoing-emails-locally.md | ||
| how-to-setup-freecodecamp-locally.md | ||
| how-to-work-on-coding-challenges.md | ||
| how-to-work-on-guide-articles.md | ||
| style-guide-for-curriculum-challenges.md | ||
| style-guide-for-guide-articles.md | ||
README.md
| Read these guidelines in | English | عربى | 中文 | русский | Português | Español | Deutsch |
Documentation Quick Reference
Hello 👋!
This directory contains all of the documentation on contributing to freeCodeCamp.org
If you are getting started, start by reading this first.
Quick references articles
1. How to work on Guide articles. 2. How to work on Coding Challenges. 3. How to setup freeCodeCamp locally. 4. How to catch outgoing emails locally.
Style guides
- Style guide for creating guide articles.
- Style guide for creating coding challenges.
Quick commands reference when working locally
A quick reference to the commands that you will need, when working locally.
| command | description |
|---|---|
npm run bootstrap |
Bootstraps the different services. |
npm run seed |
Parse all the challenge markdown files and inserts them into MongoDB. |
npm run develop |
Starts the freeCodeCamp API Server and Client Applications. |
npm test |
Run all JS tests in the system, including client, server, lint and challenge tests. |
npm run test:client |
Run the client test suite. |
npm run test:curriculum |
Run the curriculum test suite. |
npm run test:server |
Run the server test suite. |
npm run commit |
An interactive tool to help you build a good commit message. |