freeCodeCamp/CONTRIBUTING.md

68 lines
3.2 KiB
Markdown
Raw Normal View History

2018-10-07 13:39:57 +00:00
<table>
<tr>
<td> Read these guidelines in </td>
<td><a href="/CONTRIBUTING.md"> English </a></td>
<td><a href="/docs/chinese/CONTRIBUTING.md"> 中文 </a></td>
<td><a href="/docs/russian/CONTRIBUTING.md"> русский </a></td>
<td><a href="/docs/arabic/CONTRIBUTING.md"> عربى </a></td>
<td><a href="/docs/spanish/CONTRIBUTING.md"> Español </a></td>
<td><a href="/docs/portuguese/CONTRIBUTING.md"> Português </a></td>
</tr>
</table>
2018-10-07 13:39:57 +00:00
# Contributor's Guide
2018-10-07 13:39:57 +00:00
Hello 👋 !
2018-10-07 13:39:57 +00:00
freeCodeCamp.org is possible thanks to thousands of kind volunteers like you. Thanks for your interest in contributing and we are exited to welcome you onboard.
2018-10-07 13:39:57 +00:00
## Here are some fun ways you can help
2018-10-07 13:39:57 +00:00
You can choose to contribute to area of you interest:
2018-10-07 13:39:57 +00:00
### 1. Contribute to this codebase
2018-10-07 13:39:57 +00:00
We have a huge codebase of the thousands of [Curriculum challenges](https://www.freecodecamp.org/learn) and [Guide articles](https://www.freecodecamp.org/guide). These challenges and articles make up the learning content available on the main website.
2018-10-07 13:39:57 +00:00
#### You can help us
2018-10-07 13:39:57 +00:00
##### 📖 Research, Write and Update our guide articles
2018-10-07 13:39:57 +00:00
##### 💻 Create, Update and Fix Bugs in our curriculum challenges
2018-10-07 13:39:57 +00:00
##### 📚 Translate guide articles and curriculum challenges
2018-10-07 13:39:57 +00:00
You can help us translate our Guide articles and Curriculum challenges for a language that you speak. Currently we have translated versions in:
2018-10-07 13:39:57 +00:00
- Chinese : 中文
- Russian : русский
- Arabic : عربى
- Spanish : Español
- Portuguese : Português
2018-10-07 13:39:57 +00:00
Most of these are machine translated. We would love your help in updating and improving the quality of these translations.
2018-10-07 13:39:57 +00:00
##### 🛠 Help us fix bugs in the API server and client apps for freeCodeCamp.org's website
2018-10-07 13:39:57 +00:00
### 2. Help campers on our [public forum](https://www.freecodecamp.org/forum)
2018-10-07 13:39:57 +00:00
- ❓ Help campers by [answering their questions](https://www.freecodecamp.org/forum/?max_posts=1).
- 💬 [Give feedback](https://www.freecodecamp.org/forum/c/project-feedback?max_posts=1) on camper projects.
2018-10-07 13:39:57 +00:00
### 3. Help us add subtitles on our [YouTube channel.](https://www.youtube.com/freeCodeCamp/videos)
2018-10-07 13:39:57 +00:00
## Steps to contribute to the code base
2018-10-07 13:39:57 +00:00
1. :pray: Follow our [Code of Conduct](docs/CODE_OF_CONDUCT.md) at all times.
2. 🍴 [Fork this repository](https://github.com/freeCodeCamp/freeCodeCamp#fork-destination-box).
3. 👀️ Follow the contributing guidelines outlined below.
4. 🔧 Make some awesome changes!
5. 👉 [Make a pull request](https://github.com/freeCodeCamp/freeCodeCamp/compare).
6. 🎉 Get your pull request approved - success!
2018-10-07 13:39:57 +00:00
Or, If you've found a issue that is not on the board, [follow these steps](README.md#found-a-bug). If you dont wish to work on the codebase, you can [contribute in several other ways](https://contribute.freecodecamp.org).
2018-10-07 13:39:57 +00:00
Feel free to ask for help on our public [Forum](https://www.freecodecamp.org/forum) or [Contributors chat room](https://gitter.im/FreeCodeCamp/Contributors). We are excited to help you contribute to any of the projects that you would like to work on.
2018-10-07 13:39:57 +00:00
Working on your first Pull Request? You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)