docs: update contributing guides, and workflows
This commit is contained in:
48
docs/README.md
Normal file
48
docs/README.md
Normal file
@ -0,0 +1,48 @@
|
||||
<table>
|
||||
<tr>
|
||||
<td> Read these guidelines in </td>
|
||||
<td><a href="/CONTRIBUTING.md"> English </a></td>
|
||||
<td><a href="/docs/chinese/README.md"> 中文 </a></td>
|
||||
<td><a href="/docs/russian/README.md"> русский </a></td>
|
||||
<td><a href="/docs/arabic/README.md"> عربى </a></td>
|
||||
<td><a href="/docs/spanish/README.md"> Español </a></td>
|
||||
<td><a href="/docs/portuguese/README.md"> Português </a></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
# Documentation
|
||||
|
||||
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
|
||||
|
||||
1. How to work on Guide articles.
|
||||
2. How to work on Curriculum Challenges.
|
||||
3. How to setup freeCodeCamp locally.
|
||||
4. How to catch outgoing emails locally.
|
||||
|
||||
## Style guides
|
||||
|
||||
1. Style guide for creating guide articles.
|
||||
2. Style guide for creating curriculum 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 Apps |
|
||||
| `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 |
|
Reference in New Issue
Block a user