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

docs: update contributing guides (#36816)

Browse Source
This commit is contained in:
mrugesh
2019-09-20 23:56:56 +05:30
committed by GitHub
parent 0c68f6a605
commit a5b176be88
61 changed files with 552 additions and 1886 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
docs/README.md
View File

@ -1,52 +1,7 @@
<table>
<tr>
<!-- Do not translate this table -->
<td> Read these guidelines in </td>
<td><a href="/docs/README.md"> English </a></td>
<td><a href="/docs/arabic/document-quick-reference.md"> عربي </a></td>
<td><a href="/docs/chinese/document-quick-reference.md"> 中文 </a></td>
<td><a href="/docs/french/README.md"> Français </a></td>
<td><a href="/docs/german/document-quick-reference.md"> Deutsch </a></td>
<td><a href="/docs/greek/document-quick-reference.md"> Ελληνικά </a></td>
<td><a href="/docs/japanese/document-quick-reference.md"> 日本語 </a></td>
<td><a href="/docs/korean/document-quick-reference.md"> 한국어 </a></td>
<td><a href="/docs/portuguese/document-quick-reference.md"> Português </a></td>
<td><a href="/docs/russian/document-quick-reference.md"> русский </a></td>
<td><a href="/docs/spanish/document-quick-reference.md"> Español </a></td>
</tr>
</table>
<!--
# Documentation Quick Reference
This file should not be translated.
Hello 👋!
-->
This directory contains all of the documentation on contributing to freeCodeCamp.org
> ### [If you are getting started, start by reading this first.](/CONTRIBUTING.md)
## Quick references articles
<a href="/docs/how-to-work-on-guide-articles.md">1. How to work on Guide articles.</a><br>
<a href="/docs/how-to-work-on-coding-challenges.md">2. How to work on Coding Challenges.</a><br>
<a href="/docs/how-to-setup-freecodecamp-locally.md">3. How to setup freeCodeCamp locally.</a><br>
<a href="/docs/how-to-catch-outgoing-emails-locally.md">4. How to catch outgoing emails locally.</a>
<a href="/docs/devops.md">5. DevOps Guide for Core Team.</a>
## Style guides
<a href="/docs/how-to-work-on-guide-articles.md">1. Style guide for creating guide articles.</a><br>
<a href="/docs/how-to-work-on-coding-challenges.md">2. Style guide for creating coding challenges.</a>
## Quick commands reference when working locally
A quick reference to the commands that you will need when working locally.
| command | description |
| ------- | ----------- |
| `npm ci` | 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. |
> ### If you are getting started, [you should read our contributing guidelines](/CONTRIBUTING.md) first.