freeCodeCamp/docs/chinese/CONTRIBUTING.md

146 lines
8.2 KiB
Markdown
Raw Normal View History

<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-12-28 23:49:55 +00:00
freeCodeCamp.org的存在是因为像你这样的数千名志愿者。我们很感谢与欢迎您的贡献。
2018-10-16 17:07:42 +00:00
2018-12-28 23:49:55 +00:00
我们严格执行[“行为准则”]https://www.freecodecamp.org/code-of-conduct。请您花一点时间阅读它。它只有196个字。
2018-10-16 17:07:42 +00:00
祝您贡献愉快🎉!
2018-10-16 17:07:42 +00:00
##您可以由以下的方法来提供帮助
2018-10-16 17:07:42 +00:00
您可以选择为您感兴趣的任何领域做出贡献:
2018-12-28 23:49:55 +00:00
1. [贡献予开源代码库。]contribution-to-this-open-source-codebase。帮助编辑[指南文章]https://guide.freecodecamp.org/[编码挑战]https://learn.freecodecamp.org/),或修复学习平台上的错误。
2018-10-16 17:07:42 +00:00
2018-12-28 23:49:55 +00:00
2.在我们的[公共论坛]https://www.freecodecamp.org/forum/)上帮助营员。 [回答他们的编码问题]https://www.freecodecamp.org/forum/?max_posts=1或[为他们的编码项目给予反馈]https://www.freecodecamp.org/forum/c/project反馈系统开发与max_posts = 1
2018-10-16 17:07:42 +00:00
3.帮助我们为[YouTube频道视频](https://www.youtube.com/channel/UC8butISFwT-Wl7EV0hUK0BQ/videos)添加字幕。
2018-10-16 17:07:42 +00:00
2018-12-28 23:49:55 +00:00
##贡献予开源代码库
2018-10-16 17:07:42 +00:00
2018-12-28 23:49:55 +00:00
我们的开源代码库有数千个[编码挑战]https://learn.freecodecamp.org和[指南文章]https://guide.freecodecamp.org
2018-10-16 17:07:42 +00:00
您可以帮助我们:
2018-10-16 17:07:42 +00:00
- [📝研究,编写和更新我们的指南文章](research-write-and-update-our-guide-articles)
2018-10-16 17:07:42 +00:00
2018-12-28 23:49:55 +00:00
- [💻创建,更新编码挑战和修复其中的错误]create-update-and-fix-bugs-in-our-coding-challenges
2018-10-16 17:07:42 +00:00
- [🌐翻译指南文章和编码挑战](translate-guide-articles-and-coding-challenges)
2018-10-16 17:07:42 +00:00
- [🛠帮助我们修复freeCodeCamp.org学习平台中的错误](help-us-fix-bugs-in-freecodecamporgs-learning-platform)
2018-10-16 17:07:42 +00:00
###研究,编写和更新我们的指南文章
**什么是指南文章?**
2018-12-28 23:49:55 +00:00
指南文章可帮助您快速了解技术概念。它是用简短,简单的英语解释,您可以在阅读更深入的资源之前先阅读这些解释。
2018-10-16 17:07:42 +00:00
您可以在这里找到[关于HTML元素的示例文章](https://github.com/freeCodeCamp/freeCodeCamp/blob/master/guide/english/html/elements/a-tag/index.md)。
2018-10-16 17:07:42 +00:00
**我能写一篇关于什么的文章?**
2018-12-28 23:49:55 +00:00
我们欢迎您撰写这些文章的帮助。作为作者你不必是一个主题的专家 - 整个指南是开源的,所以即使你犯了错误,另一个贡献者最终会纠正它。
2018-10-16 17:07:42 +00:00
2018-12-28 23:49:55 +00:00
您可以在我们的[指南网站]https://www.freecodecamp.org/guide上找到一个“存根文章”写下您的文章然后建立pull request以替换存根文章。 [pull request]https://help.github.com/articles/about-pull-requests/)是您建议更改的方式。它让其他人了解您的更改,审核并采用它们。
2018-10-16 17:07:42 +00:00
如果您找不到关于您想要撰写的主题的存根则可以打开创建存根的PR并包含您的草稿文章。
2018-12-28 23:49:55 +00:00
如果您想帮助改进指南文章,请参阅[如何编辑指南文章]/docs/how-to-work-on-guide-articles.md
2018-10-16 17:07:42 +00:00
2018-12-28 23:49:55 +00:00
###创建,更新编码挑战和修复其中的错误
2018-10-16 17:07:42 +00:00
2018-12-28 23:49:55 +00:00
我们所有的编码挑战都由社区策划,以从您这样的志愿者那里获取专业知识。
2018-10-16 17:07:42 +00:00
2018-12-28 23:49:55 +00:00
您可以帮助扩展它们并使其措辞更加清晰。您可以更新用户故事以更好地解释概念,甚至删除多余的概念。您还可以改进挑战测试,使其更准确地测试他人的代码。
2018-10-16 17:07:42 +00:00
如果您对改进这些编码挑战感兴趣,请参阅[如何处理编码挑战](/docs/how-to-work-on-coding-challenges.md)。
2018-10-16 17:07:42 +00:00
###翻译指南文章和编码挑战
您可以帮助我们将指南文章和编码挑战翻译成您所说的语言。目前我们已翻译版本:
2018-10-16 17:07:42 +00:00
- [中文(中文)](https://github.com/freeCodeCamp/freeCodeCamp/tree/master/curriculum/challenges/chinese)
- [俄语(русский)](https://github.com/freeCodeCamp/freeCodeCamp/tree/master/curriculum/challenges/russian)
- [阿拉伯语(عربى)](https://github.com/freeCodeCamp/freeCodeCamp/tree/master/curriculum/challenges/arabic)
- [西班牙语(西班牙语)](https://github.com/freeCodeCamp/freeCodeCamp/tree/master/curriculum/challenges/spanish)
- [葡萄牙语(葡萄牙语)](https://github.com/freeCodeCamp/freeCodeCamp/tree/master/curriculum/challenges/portuguese)
2018-10-16 17:07:42 +00:00
2018-12-28 23:49:55 +00:00
我们非常欢迎您的贡献以帮助提高翻译质量。数百万人已经在使用freeCodeCamp.org的英语版本我们也希望还有数百万人使用这些翻译版本。
2018-10-16 17:07:42 +00:00
###帮助我们修复freeCodeCamp.org学习平台中的错误
我们的学习平台运行在现代JavaScript堆栈上。它有各种组件工具和库包括但不限于Node.jsMongoDBLoopBackOAuth 2.0ReactGatsbyWebpack等。
2018-12-28 23:49:55 +00:00
简单的说,
2018-10-16 17:07:42 +00:00
- 我们有一个基于Node.js的API服务器。
- 一组基于React的客户端应用程序。
2018-12-28 23:49:55 +00:00
- 用于评估前端项目的脚本。
2018-10-16 17:07:42 +00:00
为此做出贡献需要对API和ES6语法有所了解更需要足够的好奇心。
2018-10-16 17:07:42 +00:00
2018-12-28 23:49:55 +00:00
基本上我们期望您对于以上的一些技术,工具和库有某些基本的熟悉程度。但是,您不需要是这些领域的专家。
2018-10-16 17:07:42 +00:00
2018-12-28 23:49:55 +00:00
如果您对于以上相关问有任何疑问请在相关的主题上向我们提问我们将很乐意的为您澄清。您也可以联系Mrugesh Mohapatra [`@isedadead`](https://github.com/raisedadead)或Stuart Taylor [`@bouncey`](https://github.com/bouncey)为您提供帮助。
2018-10-16 17:07:42 +00:00
如果您想帮助我们改进代码库,请参阅[如何在本地设置freeCodeCamp](/docs/how-to-setup-freecodecamp-locally.md)。
2018-10-16 17:07:42 +00:00
2018-12-28 23:49:55 +00:00
## 常见的疑问
**如何报告不在记录里的问题?**
2018-10-16 17:07:42 +00:00
如果您认为自己发现了错误,请先阅读[“请帮忙!我发现了一个错误”](https://forum.freecodecamp.org/t/how-to-report-a-bug/19543)文章并按照其说明进行操作
2018-10-16 17:07:42 +00:00
如果您确信这是一个新错误请继续创建一个新的GitHub问题。请务必尽可能多地包含信息以便我们重现错误。我们有一个预定义的问题模板来帮助您完成此报告。
2018-10-16 17:07:42 +00:00
请注意,任何寻求编码帮助挑战的问题都将被关闭。问题跟踪器严格用于与代码库相关的问题和讨论。您应该[在论坛上寻求帮助](https://www.freecodecamp.org/forum), 然后在有疑问时进行报告。
2018-10-16 17:07:42 +00:00
**如何报告安全问题?**
2018-12-28 23:49:55 +00:00
请不要因安全问题而创建GitHub问题。相反请发送电子邮件至`security@freecodecamp.org`,我们会立即调查。
2018-10-16 17:07:42 +00:00
**我被困在这些文档中没有解释的问题上。怎么能得到帮助?**
2018-10-16 17:07:42 +00:00
2018-12-28 23:49:55 +00:00
您可以透过以下的管道:
2018-10-16 17:07:42 +00:00
2018-12-28 23:49:55 +00:00
- [公共论坛里的“贡献者”类别]https://www.freecodecamp.org/forum/c/contributors
- [我们的公共贡献者于Gitter中的聊天室]https://gitter.im/FreeCodeCamp/Contributors
2018-10-16 17:07:42 +00:00
我们很高兴能帮助您为您想要处理的任何课题做出贡献。确保在发布新查询之前搜索您的查询。请务必要有礼貌和耐心。我们的社区志愿者和主持人随时为您提供指导。
2018-10-16 17:07:42 +00:00
**我是GitHub和开源的新手**
阅读我们的[如何参与开源指南](https://github.com/freeCodeCamp/how-to-contribute-to-open-source)。
2018-10-16 17:07:42 +00:00
**这些标记在问题上的不同的标签是什么意思?**
2018-10-16 17:07:42 +00:00
我们的社区版主[分类](https://en.wikipedia.org/wiki/Software_bug#Bug_management) 根据优先级,严重程度和其他因素发出请求。您可以[在这里找到一个完整的含义词汇表](https://github.com/freecodecamp/freecodecamp/labels)。
2018-10-16 17:07:42 +00:00
2018-12-28 23:49:55 +00:00
您应该通过**“求助”**或**“欢迎新手”**问题快速查找您可贡献的项目。这些都是可以自行进行,并不需要批准。
如果这些项目缺乏明确的需求,请在评论中提问。
2018-10-16 17:07:42 +00:00
2018-12-28 23:49:55 +00:00
**我发现了一个错误的拼写我应该在提出PR之前报告问题吗**
2018-10-16 17:07:42 +00:00
2018-12-28 23:49:55 +00:00
对于拼写错误和其他措辞更改,您可以直接打开请求,而无需先创建问题。问题更多的是讨论与代码相关,或者课程结构方面的重大问题。
2018-10-16 17:07:42 +00:00