Skip to content
Permalink
Browse files

docs: update contributing guides (#36816)

  • Loading branch information...
raisedadead committed Sep 20, 2019
1 parent 0c68f6a commit a5b176be88e325424940ab77308c540c47c23cb8
Showing with 552 additions and 1,886 deletions.
  1. +12 −27 CONTRIBUTING.md
  2. +5 −5 README.md
  3. +4 −49 docs/README.md
  4. +0 −62 docs/arabic/document-quick-reference.md
  5. +0 −17 docs/arabic/how-to-catch-outgoing-emails-locally.md
  6. +0 −17 docs/arabic/how-to-setup-freecodecamp-locally.md
  7. +0 −17 docs/arabic/how-to-work-on-coding-challenges.md
  8. +0 −17 docs/arabic/how-to-work-on-guide-articles.md
  9. +0 −57 docs/chinese/document-quick-reference.md
  10. +5 −0 docs/devops.md
  11. +0 −54 docs/french/document-quick-reference.md
  12. +0 −54 docs/german/document-quick-reference.md
  13. +0 −142 docs/greek/CONTRIBUTING.md
  14. +0 −55 docs/greek/document-quick-reference.md
  15. +5 −0 docs/how-to-catch-outgoing-emails-locally.md
  16. +5 −0 docs/how-to-open-a-pull-request.md
  17. +25 −2 docs/how-to-setup-freecodecamp-locally.md
  18. +223 −14 docs/how-to-work-on-coding-challenges.md
  19. +0 −337 docs/how-to-work-on-guide-topics.md
  20. +8 −0 docs/i18n-languages/README.md
  21. +4 −13 docs/{ → i18n-languages}/arabic/CONTRIBUTING.md
  22. +4 −13 docs/{ → i18n-languages}/chinese/CONTRIBUTING.md
  23. 0 docs/{ → i18n-languages}/chinese/README.md
  24. +5 −13 docs/{ → i18n-languages}/chinese/how-to-catch-outgoing-emails-locally.md
  25. +12 −19 docs/{ → i18n-languages}/chinese/how-to-setup-freecodecamp-locally.md
  26. +4 −12 docs/{ → i18n-languages}/chinese/how-to-work-on-coding-challenges.md
  27. +4 −12 docs/{ → i18n-languages}/chinese/how-to-work-on-guide-articles.md
  28. +4 −13 docs/{ → i18n-languages}/french/CONTRIBUTING.md
  29. 0 docs/{ → i18n-languages}/french/README.md
  30. +4 −12 docs/{ → i18n-languages}/german/CONTRIBUTING.md
  31. +5 −14 docs/{ → i18n-languages}/italian/CONTRIBUTING.md
  32. 0 docs/{ → i18n-languages}/italian/README.md
  33. 0 docs/{ → i18n-languages}/japanese/README.md
  34. +4 −14 docs/{ → i18n-languages}/korean/CONTRIBUTING.md
  35. 0 docs/{ → i18n-languages}/korean/README.md
  36. +4 −13 docs/{ → i18n-languages}/portuguese/CONTRIBUTING.md
  37. +4 −11 docs/{ → i18n-languages}/portuguese/how-to-catch-outgoing-emails-locally.md
  38. +4 −11 docs/{ → i18n-languages}/portuguese/how-to-setup-freecodecamp-locally.md
  39. +6 −13 docs/{ → i18n-languages}/portuguese/how-to-work-on-coding-challenges.md
  40. +4 −12 docs/{ → i18n-languages}/portuguese/how-to-work-on-guide-articles.md
  41. +4 −15 docs/{romanian/README.md → i18n-languages/romanian/CONTRIBUTING.md}
  42. +4 −15 docs/{ → i18n-languages}/russian/CONTRIBUTING.md
  43. +5 −12 docs/{ → i18n-languages}/russian/how-to-catch-outgoing-emails-locally.md
  44. +5 −13 docs/{ → i18n-languages}/russian/how-to-setup-freecodecamp-locally.md
  45. +4 −11 docs/{ → i18n-languages}/russian/how-to-work-on-coding-challenges.md
  46. +10 −0 docs/i18n-languages/russian/how-to-work-on-guide-articles.md
  47. +4 −13 docs/{ → i18n-languages}/spanish/CONTRIBUTING.md
  48. 0 docs/{ → i18n-languages}/spanish/README.md
  49. +4 −16 docs/{ → i18n-languages}/spanish/document-quick-reference.md
  50. +5 −12 docs/{ → i18n-languages}/spanish/how-to-catch-outgoing-emails-locally.md
  51. +8 −16 docs/{ → i18n-languages}/spanish/how-to-setup-freecodecamp-locally.md
  52. +5 −12 docs/{ → i18n-languages}/spanish/how-to-work-on-coding-challenges.md
  53. +4 −12 docs/{ → i18n-languages}/spanish/how-to-work-on-guide-articles.md
  54. +0 −54 docs/japanese/document-quick-reference.md
  55. +0 −54 docs/korean/document-quick-reference.md
  56. +0 −54 docs/macedonian/document-quick-reference.md
  57. +0 −53 docs/portuguese/document-quick-reference.md
  58. +126 −0 docs/reply-templates.md
  59. +0 −58 docs/russian/document-quick-reference.md
  60. +0 −17 docs/russian/how-to-work-on-guide-articles.md
  61. +0 −328 docs/style-guide-for-curriculum-challenges.md
@@ -1,54 +1,39 @@
<table>
<tr>
<!-- Do not translate this table -->
<td> Read these guidelines in </td>
<td><a href="/CONTRIBUTING.md"> English </a></td>
<td><a href="/docs/arabic/CONTRIBUTING.md"> عربي </a></td>
<td><a href="/docs/chinese/CONTRIBUTING.md"> 中文 </a></td>
<td><a href="/docs/portuguese/CONTRIBUTING.md"> Português </a></td>
<td><a href="/docs/russian/CONTRIBUTING.md"> Русский </a></td>
<td><a href="/docs/spanish/CONTRIBUTING.md"> Español </a></td>
<td><a href="/docs/greek/CONTRIBUTING.md"> Ελληνικά </a></td>
</tr>
</table>
<!-- do not translate this -->
| [Read these guidelines in other languages](/docs/i18n-languages) |
|-|
<!-- do not translate this -->

# Contribution Guidelines

Hello 👋!
Hello. 👋

freeCodeCamp.org is possible, thanks to thousands of kind volunteers like you. We are grateful for your contributions and we are excited to welcome you aboard.

We strictly enforce our ["Code of Conduct"](https://www.freecodecamp.org/code-of-conduct). Take a moment to read it. It's only 196 words long.

Happy contributing 🎉!
Happy contributing.

## Here are some fun ways that you can help

You can choose to contribute to any area that interests you:
You can contribute to any of these:

1. [Contribute to this open source codebase](#contribute-to-this-open-source-codebase). Help to edit [guide articles](https://guide.freecodecamp.org/), [coding challenges](https://learn.freecodecamp.org/), or fix bugs on the learning platform.
1. [Contribute to this open source codebase](#contribute-to-this-open-source-codebase). Help us edit coding challenges, or fix bugs on the learning platform.

2. Help campers on our [public forum](https://www.freecodecamp.org/forum/). [Answer their coding questions](https://www.freecodecamp.org/forum/?max_posts=1) or [give them feedback on their coding projects](https://www.freecodecamp.org/forum/c/project-feedback?max_posts=1).

3. Help us add subtitles or closed captions to our [YouTube channel videos](https://www.youtube.com/channel/UC8butISFwT-Wl7EV0hUK0BQ/videos).
3. Help us add subtitles (closed captions) to our [YouTube channel videos](https://www.youtube.com/channel/UC8butISFwT-Wl7EV0hUK0BQ/videos).

## Contribute to this open source codebase

We have a huge open source codebase consisting of thousands of [coding challenges](https://learn.freecodecamp.org) and [guide articles](https://guide.freecodecamp.org).
Our codebase has thousands of [coding challenges](https://learn.freecodecamp.org) and other source code that powers our learning platform.

You can help us to:

- [💻 Create, Update and Fix Bugs in our coding challenges](#create-update-and-fix-bugs-in-our-coding-challenges)

- [🛠 Fix bugs in freeCodeCamp.org's learning platform](#help-us-fix-bugs-in-freecodecamporgs-learning-platform)

### Create, Update and Fix Bugs in our coding challenges
### Create, update and fix bugs in our coding challenges

All our coding challenges are curated by the community, bringing in expert knowledge from volunteers like you.

You can help expand them and make their wording clearer. You can update the user stories to explain the concept better and even remove redundant ones. You can also improve the challenge tests to make them more accurately test people's code.

If you're interested in improving these coding challenges, here's [how to work on coding challenges](/docs/how-to-work-on-coding-challenges.md).
**If you're interested in improving these coding challenges, here's [how to work on coding challenges](/docs/how-to-work-on-coding-challenges.md).**

### Help us fix bugs in freeCodeCamp.org's learning platform

@@ -5,7 +5,7 @@
[![Open Source Helpers](https://www.codetriage.com/freecodecamp/freecodecamp/badges/users.svg)](https://www.codetriage.com/freecodecamp/freecodecamp)
[![Setup Automated](https://img.shields.io/badge/setup-automated-blue?logo=gitpod)](https://gitpod.io/from-referrer/)

## Welcome to freeCodeCamp.org's open source codebase and curriculum
## freeCodeCamp.org's open source codebase and curriculum

[freeCodeCamp.org](https://www.freecodecamp.org) is a friendly community where you can learn to code for free. It is run by a [donor-supported 501(c)(3) nonprofit](https://donate.freecodecamp.org) with the goal of helping millions of busy adults transition into tech. Our community has already helped more than 10,000 people get their first developer job.

@@ -123,16 +123,16 @@ Our community also has:
- A [forum](https://www.freecodecamp.org/forum) where you can usually get programming help or project feedback within hours.
- A [YouTube channel](https://youtube.com/freecodecamp) with free courses on Python, SQL, Android, and a wide variety of other technologies.
- A [podcast](https://podcast.freecodecamp.org/) with technology insights and inspiring stories from developers.
- [Local study groups](https://study-group-directory.freecodecamp.org/) around the world, where you can code together in person
- A comprehensive [guide to thousands of programming topics](https://guide.freecodecamp.org/)
- A [Developer News](https://www.freecodecamp.org/news) publication, a free, open source, no-ads place to cross-post your blog articles.
- A [Facebook group](https://www.facebook.com/groups/freeCodeCampEarth/permalink/428140994253892/) with over 100,000 members worldwide

> ### [Join our community here](https://www.freecodecamp.org/signin).
### Reporting Bugs and Issues

If you think you've found a bug, first read the [How to Report a Bug](https://www.freecodecamp.org/forum/t/how-to-report-a-bug/19543) article and follow its instructions. If you're confident it's a new bug, and have confirmed that someone else is facing the same issue, go ahead and create a new GitHub issue. Be sure to include as much information as possible so we can reproduce the bug.
If you think you've found a bug, first read the [how to report a bug](https://www.freecodecamp.org/forum/t/how-to-report-a-bug/19543) article and follow its instructions.

If you're confident it's a new bug, and have confirmed that someone else is facing the same issue, go ahead and create a new GitHub issue. Be sure to include as much information as possible so we can reproduce the bug.

### Reporting Security Issues

@@ -144,7 +144,7 @@ If you think you have found a vulnerability, please report responsibly. Don't cr
### Platform, Build and Deployment Status

The build and deployment status for the code is available in [our DevOps Guide](/docs/devops.md). The general platform status for all our applications is available at [`status.freecodecamp.org`](https://status.freecodecamp.org)
The general platform status for all our applications is available at [`status.freecodecamp.org`](https://status.freecodecamp.org). The build and deployment status for the code is available in [our DevOps Guide](/docs/devops.md).

### License

@@ -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.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

@@ -1,3 +1,8 @@
<!-- do not translate this -->
| [Read these guidelines in other languages](/docs/i18n-languages) |
|-|
<!-- do not translate this -->

# DevOps Guide

> ### :warning: THIS GUIDE IS NOT LIVE YET. :warning:

0 comments on commit a5b176b

Please sign in to comment.
You can’t perform that action at this time.