From 46c3cd326594516376d01dfe54be33a107b927c6 Mon Sep 17 00:00:00 2001 From: mrugesh <1884376+raisedadead@users.noreply.github.com> Date: Fri, 27 Mar 2020 14:19:49 +0530 Subject: [PATCH] revert(docs): Fixed Chinese broken link and markdown (#38458) This reverts commit 552203c0b0178f96e7a2f371f2e273cf570adf31 merged via #37278 Co-authored-by: miyaliu666 --- docs/i18n-languages/chinese/CONTRIBUTING.md | 126 ++++++++++-------- docs/i18n-languages/chinese/README.md | 2 +- .../how-to-work-on-coding-challenges.md | 70 +++++----- 3 files changed, 105 insertions(+), 93 deletions(-) diff --git a/docs/i18n-languages/chinese/CONTRIBUTING.md b/docs/i18n-languages/chinese/CONTRIBUTING.md index 830e1e3258..993e0a9e75 100644 --- a/docs/i18n-languages/chinese/CONTRIBUTING.md +++ b/docs/i18n-languages/chinese/CONTRIBUTING.md @@ -7,9 +7,9 @@ 您好👋！ -freeCodeCamp.org的存在是因为像你这样的数千名志愿者。我们很感谢与欢迎您的贡献和歡迎你的光臨。 +freeCodeCamp.org的存在是因为像你这样的数千名志愿者。我们很感谢与欢迎您的贡献。 -我们严格执行[「行为准则」](https://www.freecodecamp.org/code-of-conduct)。请您花一点时间阅读它。它只有196个字。 +我们严格执行[“行为准则”](https://www.freecodecamp.org/code-of-conduct)。请您花一点时间阅读它。它只有196个字。 贡献愉快🎉！ @@ -17,15 +17,43 @@ freeCodeCamp.org的存在是因为像你这样的数千名志愿者。我们很 您可以选择为您感兴趣的任何领域做出贡献： -1. [贡献這個开源代码库](#贡献這個开源代码库)。帮助编编码挑战，或修复学习平台上的错误。 +1. [贡献予开源代码库](#贡献予开源代码库)。帮助编辑[指南文章](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-feedback?max_posts=1)。 3. 帮助我们为[YouTube频道视频](https://www.youtube.com/channel/UC8butISFwT-Wl7EV0hUK0BQ/videos)添加字幕。 -## 贡献這個开源代码库 +## 贡献予开源代码库 -我们有数以千计的[编码挑战](https://learn.freecodecamp.org)和其他开源代码库在我们的学习平台中。 +我们有数以千计的[编码挑战](https://learn.freecodecamp.org)和[指南文章](https://guide.freecodecamp.org)集中在这个庞大的开源代码库中。 + +您可以帮助我们： + +- [📝 研究，编写和更新我们的指南文章](#研究编写和更新我们的指南文章) + +- [💻 创建，更新编码挑战和修复其中的错误](#创建更新编码挑战和修复其中的错误) + +- [🌐 翻译指南文章和编码挑战](#翻译指南文章和编码挑战) + +- [🛠 帮助我们修复freeCodeCamp.org学习平台中的错误](#帮助我们修复freecodecamporg学习平台中的错误) + +### 研究，编写和更新我们的指南文章 + +**什么是指南文章？** + +指南文章可帮助您快速了解技术概念。它是用简短，简单的英语解释，您可以在阅读更深入的资源之前先阅读这些解释。 + +您可以在这里找到[关于HTML锚点元素的示例文章](https://github.com/freeCodeCamp/freeCodeCamp/blob/master/guide/english/html/elements/a-tag/index.md)。 + +**我能写一篇关于什么的文章？** + +我们欢迎您撰写这些文章的帮助。作为作者你不必是一个主题的专家 - 整个指南是开源的，所以即使你犯了错误，另一个贡献者最终会纠正它。 + +您可以在我们的[指南网站](https://www.freecodecamp.org/guide)上找到一个“存根文章”，写下您的文章，然后建立pull request以替换存根文章。 [pull request](https://help.github.com/articles/about-pull-requests/)是您建议更改的方式。它让其他人了解您的更改，审核并采用它们。 + +如果您找不到关于您想要撰写的主题的存根，则可以开一个PR，创建有关存根并包含您的草稿文章。 + +如果您想帮助改进指南文章，请参阅[如何编辑指南文章](/docs/chinese/how-to-work-on-guide-articles.md)。 ### 创建，更新编码挑战和修复其中的错误 @@ -33,7 +61,19 @@ freeCodeCamp.org的存在是因为像你这样的数千名志愿者。我们很 您可以帮助扩展它们并使其措辞更加清晰。您可以更新用户故事以更好地解释概念，甚至删除多余的概念。您还可以改进挑战测试，使其更准确地测试人们的代码。 -**如果您对改进这些编码挑战感兴趣，请参阅[如何处理编码挑战](how-to-work-on-coding-challenges.md)。** +如果您对改进这些编码挑战感兴趣，请参阅[如何处理编码挑战](/docs/chinese/how-to-work-on-coding-challenges.md)。 + +### 翻译指南文章和编码挑战 + +您可以帮助我们将指南文章和编码挑战翻译成您所说的语言。目前我们已翻译版本： + +- [中文（中文）](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) + +我们非常欢迎您的贡献以帮助提高翻译质量。数百万人已经在使用freeCodeCamp.org的英语版本，我们也希望还有数百万人使用这些翻译版本。 ### 帮助我们修复freeCodeCamp.org学习平台中的错误 @@ -41,80 +81,54 @@ freeCodeCamp.org的存在是因为像你这样的数千名志愿者。我们很 简单的说， -- 我们有一个基于Node.js的API服务器。 -- 一系列基于React的客户端应用程序。 -- 一个用于评估前端项目的脚本。 + - 我们有一个基于Node.js的API服务器。 + - 一系列基于React的客户端应用程序。 + - 一个用于评估前端项目的脚本。 + 为此做出贡献需要对API和ES6语法有所了解，更需要足够的好奇心。 基本上我们期望您对于以上的一些技术，工具和库有某些基本的熟悉程度。但是，您不需要是这些领域的专家。 -**如果您想帮助我们改进代码库，请参阅[如何在本地启动freeCodeCamp](how-to-setup-freecodecamp-locally.md)。** +如果您对于以上相关问有任何疑问，请在相关的主题上向我们提问，我们将很乐意的为您澄清。您可以联系我们的平台开发团队中的Mrugesh Mohapatra [`@isedadead`](https://github.com/raisedadead) 或Stuart Taylor [`@bouncey`](https://github.com/bouncey) 为您提供帮助。 -[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/freeCodeCamp/freeCodeCamp) - -(Starts a ready-to-code dev environment for freecodecamp in your browser.) +如果您想帮助我们改进代码库，请参阅[如何在本地启动freeCodeCamp](/docs/chinese/how-to-setup-freecodecamp-locally.md)。 ## 常见的疑问 -### 如何报告不在记录里的问题？ +**如何报告不在记录里的问题？** -如果您认为自己发现了错误，请先阅读[「请帮忙！我发现了一个错误」](https://forum.freecodecamp.org/t/how-to-report-a-bug/19543)文章并按照其说明进行操作 +如果您认为自己发现了错误，请先阅读[“请帮忙！我发现了一个错误”](https://forum.freecodecamp.org/t/how-to-report-a-bug/19543)文章并按照其说明进行操作 如果您确信这是一个新错误，请继续创建一个新的GitHub问题。请务必尽可能多地包含信息，以便我们能重现错误。我们有一个预定义的问题模板来帮助您完成此报告。 请注意，任何寻求编码帮助挑战的问题都将被关闭。问题跟踪器严格用于与代码库相关的问题和讨论。您应该[在论坛上寻求帮助](https://www.freecodecamp.org/forum), 然后在有疑问时进行报告。 -### 如何报告安全问题？ +**如何报告安全问题？** 请不要因安全问题而创建GitHub问题。相反，请发送电子邮件至`security@freecodecamp.org`，我们会立即调查。 -### 这些标记在问题上的不同的标签(label)是什么意思？ - -我们的社区版主根据优先级、严重程度和其他因素将问题和PR[分类](https://en.wikipedia.org/wiki/Software_bug#Bug_management)。您可以[在这里找到一个完整的含义词汇表](https://github.com/freecodecamp/freecodecamp/labels)。 - -您应该通过[**help wanted**](https://github.com/freeCodeCamp/freeCodeCamp/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22)或[**first timers welcome**](https://github.com/freeCodeCamp/freeCodeCamp/issues?q=is%3Aopen+is%3Aissue+label%3A%22first+timers+welcome%22)快速查找您可以贡献的项目。这些都是可以自行进行，并不需要批准。 - -### 我发现了一个错误的拼写，我应该在提出PR之前报告问题吗？ - -对于拼写错误和其他措辞更改，您可以直接提出PR，而无需先创建问题。问题更多的是讨论与代码相关，或者课程结构方面的重大问题。 - -### 如何得到分配给我的问题？ - -我们通常不会分配问题给长期贡献者以外的人以避免模棱两可的情形，相反的我们遵循以下对所有人公平的政策： - -1. 对于任何问题，第一个请求请求将被合并。 -2. 如果对同一问题有多个请求请求，我们会优先考虑请求请求中代码的质量。 - - 是否包含测试？ - - 是否抓住了所有用例？ - - 确定所有测试都通过了吗，并且确认一切在本地进行正常？ -3. 最后，我们偏好遵循我们建议准则的请求。 - - 是否遵循请求的确认清单？ - - 是否有意义地命名了请求的标题？ - -如前所述，对于标记为 `help wanted` 或 `first timers welcome` 的问题，您不需要任何许可。认真遵循准则和打开请求。 - -### 我是GitHub和开源的新手： - -阅读我们的[如何参与开源指南](https://github.com/freeCodeCamp/how-to-contribute-to-open-source)。 - -如果这些问题缺乏明确的需求，欢迎在评论中提问。 - -### 我被困在这些文档中没有解释的问题上。怎么能得到帮助？ +**我被困在这些文档中没有解释的问题上。怎么能得到帮助？** 您可以通过以下的渠道： -- [我们公共论坛上的「贡献者」类别](https://www.freecodecamp.org/forum/c/contributors) +- [我们公共论坛上的“贡献者”类别](https://www.freecodecamp.org/forum/c/contributors) - [我们的公共贡献者在Gitter的聊天室](https://gitter.im/FreeCodeCamp/Contributors) 我们很高兴能帮助您为您想要处理的任何问题做出贡献。确保在发布新问题之前搜索您的问题。请务必要有礼貌和耐心。我们的社区志愿者和主持人随时为您提供指导。 -當遇到任何疑问，您可以联系我们平台的开发团队为您提供帮助： +**我是GitHub和开源的新手：** -| 名字 | GitHub | Twitter | -|:----------------|:-------|:--------| -| Mrugesh Mohapatra | [`@raisedadead`](https://github.com/raisedadead) | [`@raisedadead`](https://twitter.com/raisedadead)| -| Ahmad Abdolsaheb | [`@ahmadabdolsaheb`](https://github.com/ahmadabdolsaheb) | [`@Abdolsaheb`](https://twitter.com/Abdolsaheb) | -| Kristofer Koishigawa | [`@scissorsneedfoodtoo`](https://github.com/scissorsneedfoodtoo) | [`@kriskoishigawa`](https://twitter.com/kriskoishigawa) | +阅读我们的[如何参与开源指南](https://github.com/freeCodeCamp/how-to-contribute-to-open-source)。 -> **Email: `dev@freecodecamp.org`** +**这些标记在问题上的不同的标签(label)是什么意思？** + +我们的社区版主根据优先级、严重程度和其他因素将问题和PR[分类](https://en.wikipedia.org/wiki/Software_bug#Bug_management)。您可以[在这里找到一个完整的含义词汇表](https://github.com/freecodecamp/freecodecamp/labels)。 + +您应该通过[**“求助”**](https://github.com/freeCodeCamp/freeCodeCamp/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22)或[**“欢迎新手”**](https://github.com/freeCodeCamp/freeCodeCamp/issues?q=is%3Aopen+is%3Aissue+label%3A%22first+timers+welcome%22)快速查找您可以贡献的项目。这些都是可以自行进行，并不需要批准。 + +如果这些问题缺乏明确的需求，欢迎在评论中提问。 + +**我发现了一个错误的拼写，我应该在提出PR之前报告问题吗？** + +对于拼写错误和其他措辞更改，您可以直接提出PR，而无需先创建问题。问题更多的是讨论与代码相关，或者课程结构方面的重大问题。 diff --git a/docs/i18n-languages/chinese/README.md b/docs/i18n-languages/chinese/README.md index 27ec88ce50..1e6be44260 100644 --- a/docs/i18n-languages/chinese/README.md +++ b/docs/i18n-languages/chinese/README.md @@ -130,7 +130,7 @@ freeCodeCamp.org提供了一些免费的开发技能认证证书。每个证书 ### 参与贡献 -#### [请遵循这个步骤参与贡献。](./CONTRIBUTING.md) +#### [请遵循这个步骤参与贡献。](/docs/chinese/CONTRIBUTING.md) ### 开源许可 diff --git a/docs/i18n-languages/chinese/how-to-work-on-coding-challenges.md b/docs/i18n-languages/chinese/how-to-work-on-coding-challenges.md index 878ac1f426..a3a7cf0d2c 100644 --- a/docs/i18n-languages/chinese/how-to-work-on-coding-challenges.md +++ b/docs/i18n-languages/chinese/how-to-work-on-coding-challenges.md @@ -3,9 +3,9 @@ |-| -# 如何处理编码挑战 +＃如何处理编码挑战 -### 在GitHub上更改 +###在GitHub上更改 每个挑战都存储在自己的markdown文件中。这使得从GitHub中编辑挑战变得容易。 @@ -13,9 +13,9 @@ 在GitHub界面中找到要修改的文件后，单击铅笔图标开始编辑文件。如果您还没有这个项目的分支，将会自动创建一个新的分支。 -您还可以复制项目并在计算机上进行本地编辑。如需帮助，请阅读主要[贡献指南](./CONTRIBUTING.md)。 +您还可以复制项目并在计算机上进行本地编辑。如需帮助，请阅读主要[贡献指南](/CONTRIBUTING.md)。 -### 挑战模板 +###挑战模板 这是挑战markdown文件的模板。 @@ -28,73 +28,71 @@ guideUrl：'引导文章的网址' videoUrl：'视频解释的网址' --- -## 说明 -
+##说明 +
挑战的描述以及通过的要求 -
+ -## 说明 -
+##说明 +
关于究竟需要做什么的说明。 -
- -## 测试 + +##测试
```yml - - text：应该返回“foo”。 - testString：'使用Chai断言的字符串化函数' + - 文字：应该返回“foo”。 +  testString：'使用Chai断言的字符串化函数' ``` -
+ -## 挑战原因 -
+
-
- -```{ext} +```JS 默认情况下，代码在编辑器中显示。 ``` -
+ -### 测试前 -
+###测试前 +
-```{ext} +```JS 测试设置代码。 ```
-### 经过测试 -
+ -```{ext} +###经过测试 +
+ +```JS 测试拆解代码。 ``` -
+ -
+ -## 解决方案 +##解决方案
-```{ext} +```JS 挑战解决方案代码 ``` -
+ ```` -### 有用的链接 +###有用的链接 创建和编辑挑战： -1. [挑战风格指南](style-guide-for-curriculum-challenges.md) - 如何创建和格式化挑战 +1. [挑战风格指南]（style-guide-for-curriculum-challenges.md） - 如何创建和格式化挑战 -2. [挑战类型](https://github.com/freeCodeCamp/learn/blob/a5cb25704168aa37f59a582f0bb5a19b7bd89b46/utils/challengeTypes.js) - 数字挑战类型值的含义（枚举）。 +2. [挑战类型]（https://github.com/freeCodeCamp/learn/blob/a5cb25704168aa37f59a582f0bb5a19b7bd89b46/utils/challengeTypes.js） - 数字挑战类型值的含义（枚举）。 -3. [贡献FreeCodeCamp - 编写ES6挑战测试](https://www.youtube.com/watch?v=iOdD84OSfAE#t=2h49m55s) - 视频[Ethan Arrowood]（https://twitter.com/ ArrowoodTech）因为他对旧版课程做出了贡献 +3. [贡献FreeCodeCamp - 编写ES6挑战测试]（https://www.youtube.com/watch?v=iOdD84OSfAE#t=2h49m55s） - 视频[Ethan Arrowood]（https://twitter.com/ ArrowoodTech）因为他对旧版课程做出了贡献