Skip to content

Latest commit

 

History

History
140 lines (79 loc) · 8.31 KB

CONTRIBUTING.md

File metadata and controls

140 lines (79 loc) · 8.31 KB
Raw
Read these guidelines in English 中文 русский عربى Español Português

Contribution Guidelines

你好👋！

感谢像你这样的数千名志愿者，freeCodeCamp.org。我们感谢您的贡献，我们很高兴欢迎您的光临。

我们严格执行[“行为准则”]（https://www.freecodecamp.org/code-of-conduct）。花一点时间阅读它。它只有196个字。

快乐贡献🎉！

##这里有一些有趣的方法可以提供帮助

您可以选择为您感兴趣的任何领域做出贡献：

  1. [有助于这个开源代码库。]（＃contribution-to-this-open-source-codebase）。帮助编辑[指南文章]（https://guide.freecodecamp.org/），[编码挑战]（https://learn.freecodecamp.org/），或修复学习平台上的错误。

2.在我们的[公共论坛]（https://www.freecodecamp.org/forum/）上帮助营员。 [回答他们的编码问题]（https://www.freecodecamp.org/forum/?max_posts=1）或[给他们反馈他们的编码项目]（https://www.freecodecamp.org/forum/c/project反馈系统开发与？max_posts = 1）

3.帮助我们为[YouTube频道视频]（https://www.youtube.com/channel/UC8butISFwT-Wl7EV0hUK0BQ/videos）添加字幕。

##有助于这个开源代码库

我们有数千个[编码挑战]（https://learn.freecodecamp.org）和[指南文章]（https://guide.freecodecamp.org）的庞大开源代码库。

你可以帮助我们：

  • [📝研究，编写和更新我们的指南文章]（＃research-write-and-update-our-guide-articles）

  • [💻在我们的编码挑战中创建，更新和修复错误]（＃create-update-and-fix-bugs-in-our-coding-challenges）

  • [🌐翻译指南文章和编码挑战]（＃translate-guide-articles-and-coding-challenges）

  • [🛠帮助我们修复freeCodeCamp.org学习平台中的错误]（＃help-us-fix-bugs-in-freecodecamporgs-learning-platform）

###研究，编写和更新我们的指南文章

什么是指南文章？

指南文章可帮助您快速了解技术概念。这些是简短的，简单的英语解释，您可以在继续阅读更深入的资源之前阅读这些解释。

您可以在这里找到[关于HTML元素的示例文章]（./client/src/pages /html/elements/index.md）。

我能写一篇关于什么的文章？

我们欢迎您撰写这些文章的帮助。你不必成为一个主题的专家来写它 - 整个指南是开源的，所以即使你犯了错误，另一个贡献者最终会纠正它。

为了帮助，在我们的[指南网站]（https://www.freecodecamp.org/guide）上找到一个“存根文章”，写下文章，然后打开拉取请求，用您的文章替换存根。 [pull request]（https://help.github.com/articles/about-pull-requests/）是您建议更改的方式。它让其他人了解您的更改，审核并采用它们。

如果您找不到关于您想要撰写的主题的存根，则可以打开创建存根的PR并包含您的草稿文章。

如果您想帮助改进指南文章，请参阅[如何处理指南文章]（/ docs / how-to-work-on-guide-articles.md）。

###在我们的编码挑战中创建，更新和修复错误

我们所有的编码挑战都由社区策划，从您这样的志愿者那里获取专业知识。

您可以帮助扩展它们并使其措辞更加清晰。您可以更新用户故事以更好地解释概念，甚至删除多余的概念。您还可以改进挑战测试，使其更准确地测试人员的代码。

如果您对改进这些编码挑战感兴趣，请参阅[如何处理编码挑战]（/ docs / how-to-work-on-coding-challenges.md）。

###翻译指南文章和编码挑战

您可以帮助我们翻译我们的指南文章和您所说语言的编码挑战。目前我们已翻译版本：

我们非常乐意帮助您提高翻译质量。数百万人使用freeCodeCamp.org的英语版本，我们希望还有数百万人使用这些翻译版本。

###帮助我们修复freeCodeCamp.org学习平台中的错误

我们的学习平台运行在现代JavaScript堆栈上。它有各种组件，工具和库，包括但不限于Node.js，MongoDB，LoopBack，OAuth 2.0，React，Gatsby，Webpack等。

宽广地，

  • 我们有一个基于Node.js的API服务器。
  • 一组基于React的客户端应用程序。
  • 我们用来评估我们的前端项目的脚本。

为此做出贡献需要对API，ES6语法和许多好奇心有所了解。

基本上我们期望某些基本的熟悉程度，以及一些上述技术，工具和库。也就是说，您不需要成为他们的专家。

请在相关问题主题上随意向我们提问，我们将很乐意澄清。如有疑问，您可以从我们的平台开发处联系Mrugesh Mohapatra [@isedadead]（https://github.com/raisedadead）或Stuart Taylor [@bouncey]（https://github.com/bouncey）团队为您提供帮助。

如果您想帮助我们改进代码库，请参阅[如何在本地设置freeCodeCamp]（/ docs / how-to-setup-freecodecamp-locally.md）。

＃＃ 经常问的问题

如何报告不在船上的错误？

如果您认为自己发现了错误，请先阅读[“我发现了一个错误的帮助”]（https://forum.freecodecamp.org/t/how-to-report-a-bug/19543）文章并按照其说明进行操作

如果您确信这是一个新错误，请继续创建一个新的GitHub问题。请务必尽可能多地包含信息，以便我们重现错误。我们有一个预定义的问题模板来帮助您完成此操作。

请注意，任何寻求编码帮助挑战的问题都将被关闭。问题跟踪器严格用于与代码库相关的问题和讨论。您应该[在论坛上寻求帮助]（https://www.freecodecamp.org/forum），然后在有疑问时进行报告。

如何报告安全问题？

请不要因安全问题而创建GitHub问题。相反，请发送电子邮件至security @ freecodecamp.org，我们会立即调查。

我被困在这些文档中没有的东西上。怎么能得到帮助？

随意寻求帮助：

我们很高兴能帮助您为您想要处理的任何主题做出贡献。确保在发布新查询之前搜索您的查询。要有礼貌和耐心。我们的社区志愿者和主持人随时为您提供指导。

我是GitHub和开源的新手：

阅读我们的[如何参与开源指南]（https://github.com/freeCodeCamp/how-to-contribute-to-open-source）。

这些不同的标签是什么意思，在问题上被标记？

我们的社区版主[分类]（https://en.wikipedia.org/wiki/Software_bug#Bug_management）根据优先级，严重程度和其他因素发出请求。你可以[在这里找到一个完整的含义词汇表]（https://github.com/freecodecamp/freecodecamp/labels）。

您应该通过**“求助”**或“第一次欢迎”**问题快速查找可供您使用的内容。这些都是可以抓住的，在开始研究之前你不需要继续。

如果这些问题在需要完成的工作上缺乏明确性，请在评论中随意提问。

我发现了一个拼写错误，我应该在提出拉取请求之前报告问题吗？

对于拼写错误和其他措辞更改，您可以直接打开请求，而无需先创建问题。问题更多的是讨论与代码相关的更大问题，或者课程的更多结构方面。