273 lines
13 KiB
Markdown
273 lines
13 KiB
Markdown
<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/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>
|
||
|
||
#如何在指南文章工作
|
||
在您的帮助下，我们可以创造将帮助成千上万人学会未来几年编码的一个全面参考工具。 💛
|
||
您能：
|
||
- [帮助我们通过创造和编辑指南文章](#steps为创造和编辑指南文章)。
|
||
- [帮助回顾拉扯要求指南文章(]) ##
|
||
步的我们为创造和编辑指南文章
|
||
1。 🍴 [叉子这repo] (https://github.com/freeCodeCamp/freeCodeCamp#fork-destination-box)
|
||
2。 👀️遵循如下所示的贡献的指导方针。
|
||
3. 🔧做一些令人敬畏的变动!
|
||
4. 📖读了这个 [样式指南为最佳的实践](/docs/style指南为指南文章)。
|
||
5. 👉 [做拉扯请求](https://github.com/freeCodeCamp/freeCodeCamp/compare)
|
||
6。 🎉得到您的拉扯请求被批准-成功!
|
||
或请 [创造一个问题](https://github.com/freeCodeCamp/freeCodeCamp/issues) -任何一点帮助计数! 😊
|
||
### [遵循这些被推荐的指导方针从我们的样式指南为创造拉扯请求](PR)的
|
||
一強制指南文章(/docs/style指南为指南articles.md) ###提出那里
|
||
变动是您能提出对贮藏库的变动的二种方式，在您编辑或增加一篇指南文章之后：
|
||
- [使用GitHub网接口在您的浏览器](#using这github网接口在你浏览器)。
|
||
- [工作在您的地方机器](#working在你地方机器) (_recommended_为预览变动)。
|
||
####使用GitHub网接口在您的浏览器
|
||
手表录影示范或在它之下跟随步：
|
||
**[ TODO] **更新GIF录音。
|
||
! [显示GitHub接口的GIF跨步](#)
|
||
1。 进入** “页” **文件夹(位于 [`客户或src或者页或者指南`](/client/src/pages/guide)) 并且发现您希望写或编辑的文章残余部分。
|
||
> 所有残余部分在index.md文件
|
||
2。 点击<kbd>Edit这个file</kbd>铅笔像并且做您的对文件的变动在GitHub调味的减价。
|
||
> 如果像是greyed，并且发出您警告“您必须是在做或提出对这个文件的变动的分支”，则您是可能的在另一个人的树。 在顶面左页，有认为“树的下落下来装箱： #######". 点击下落下来并且改变分支到“大师”。 铅笔像应该现在clickable。
|
||
3. 纸卷对底部的屏幕和增加解释您的变动的一则做消息。
|
||
(任意) ： 我们高度推荐做常规做消息。 这是您在某些将看普遍的开放来源贮藏库的很好的练习。 作为开发商，这鼓励您跟随标准操作。
|
||
有些例子的常规做消息是：
|
||
```md
|
||
固定： 更新HTML指南文章
|
||
固定： 更新修造剧本为TravisCI
|
||
技艺： 增加文章为Java语言卷扬
|
||
docs ： 更新贡献的指南
|
||
```
|
||
保留这些短小，不超过50个字符。 您在做消息的描述能总增加其它信息。
|
||
这比一则跌荡的消息象‘更新文件’或‘增加index.md’不花费另外的时间
|
||
您能学会更多在大约 [为什么您这里如果这些](https://www.conventionalcommits.org/en/v1.0.0-beta.2/#why-use-conventional-commits)。
|
||
4. 然后选择单选按钮选择为** “创造一个新的分支为此做并且开始拉扯请求” **并且点击<kbd>Propose文件changes</kbd>。
|
||
|
||
5. 在下个屏幕，您能增加关于您的PR的所有其他细节，然后点击<kbd>Create拉扯request</kbd>。
|
||
祝贺🎉! 您创造了拉扯请求。
|
||
运作在您的地方机器(_recommended_的####为预览变动)
|
||
没有要求您在您的地方机器工作，除非您希望预览您编辑或者与UI固定和改进一起使用。 也推荐这您是否跑入git问题象合并冲突， rebasing等等。
|
||
#####读了这些指南关于 [怎样设定得到PR的]地方freeCodeCamp (
|
||
/docs/how对设定freecodecamp locally.md) ###这里
|
||
被接受是评论者遵循的几指导方针，当回顾PRs时：
|
||
-有一个相关的描述，并且标题
|
||
- PR尊敬 [样式指南](/docs/style指南为指南文章)
|
||
-我们跟随在调解人指南发现的一般 [QA技巧](https://forum.freecodecamp.org/t/freecodecamp-moderator-guidelines/18295)
|
||
-，只要拉扯请求改进或扩展指南，我们接受它，即使它包含不完美的英国或部份内容
|
||
-更旧的拉扯请求是被回顾的第一个
|
||
####标签
|
||
- **内容**是为在指南的拉扯请求(他们修改文章内容增加一篇新的文章或更新一篇现有的文章)
|
||
- **复制品**是为有内容和一样另一开放PR -的拉扯
|
||
请求**以前需要变动的变动请求**是为拉扯请求 得到被合并的
|
||
- **陈旧**为拉扯请求与_ “改变没在大约2个星期以后得到活动，并且随后是闭合的请求的” _标签。
|
||
- _stale_拉扯请求应该是闭合的。
|
||
-这 [例子](https://github.com/freeCodeCamp/freeCodeCamp/pull/235)。
|
||
####相冲突或复制内容
|
||
A PR被认为a **复制品**，如果它做对文章的变动和另一PR一样。
|
||
一般来说，评论者将：
|
||
1. 排序PR从最旧
|
||
2。 查寻PRs与相似的内容
|
||
3。 合并从最老到它是
|
||
非常可能的那里的最新将是合并冲突与复制PRs。
|
||
评论者将作出每一努力解决这些冲突和合并复制PRs。
|
||
####请求变动
|
||
，如果拉扯请求不是完善的，评论者可以：
|
||
-对贡献者的请求变动和增加*changes requested*标签
|
||
-固定较小问题并且做做在所有PRs
|
||
必须通过Travis
|
||
CI检查的PR #### Travis CI修造顶部，在我们可以合并它之前。
|
||
如果PR打破修造(Travis CI支票发生故障，并且展示红色“X”)那里是三个可能的来源。
|
||
在我们可以合并您的PR之前，您将需要修理问题：
|
||
1. 您的PR创造一篇新的文章，并且它错过`index.md `文件某处。
|
||
-每个文件夹在`src或页`在它(和名字需要`index.md `文件必须是`index.md `)。
|
||
-二个可能的情景是
|
||
除`index.md `之外， -您命名了新的文章文件某事或者
|
||
-您创造了一个新的文件夹，然后次级文件夹，您在次级文件夹在新的文件夹2写新的文章，但忘记投入残余部分`index.md `
|
||
|
||
2.您的PR創建一個新文件夾，文件夾名稱格式不正確。
|
||
- 您的文件夾名稱應全部小寫並以kebab-case格式化（即my-new-folder）。
|
||
這篇文章的頂部沒有`title`字段。
|
||
- 請參閱下面[編寫文章的樣式指南]下的[標題]（＃title）部分（/ docs / style-guide-for-guide-articles.md）。
|
||
|
||
###我們何時關閉拉取請求
|
||
|
||
我們關閉拉取請求
|
||
|
||
- 如果同一篇文章的較舊PR合併，並且您的PR不添加新內容
|
||
- 如果它沒有/很少的努力（例如：從維基百科等其他來源複製粘貼）
|
||
- 如果有受版權保護的來源複製文本 - 請參閱[引用問題]（https://github.com/freeCodeCamp/freeCodeCamp/issues/2503）
|
||
- 如果它不尊重[撰寫文章的風格指南]（/ docs / style-guide-for-guide-articles.md）
|
||
- 如果不尊重[學術誠信政策]（https://www.freecodecamp.org/academic-honesty）
|
||
- 如果它是陳舊的（如果要求更改並且約2週沒有活動）
|
||
|
||
此外，如果您正在處理“存根”文章，則您的更改必須足夠大，以替換存根文本。
|
||
|
||
我們不接受只添加“更多信息：”部分鏈接的公關。
|
||
|
||
存儲庫有一個`Normalise.js`腳本，它為鏈接添加屬性，但也通過RegEx檢查“這是一個存根...”文本。
|
||
|
||
如果找到，它會將文章文本還原為通用存根文本（並刪除更改）。
|
||
|
||
這是預期的行為，因為它允許我們在模板存根因任何原因而更改時更新所有存根。
|
||
|
||
###獲得幫助
|
||
|
||
這是一個由整個貢獻者團隊提供支持的社區，您可以從中汲取創意，並在撰寫時提出意見。
|
||
|
||
保持活躍在[貢獻者聊天室]（https://gitter.im/freecodecamp/contributors）並提出很多問題。
|
||
|
||
---
|
||
|
||
##披露指南文章拉取請求的步驟
|
||
|
||
>本節針對此回購的評論者。
|
||
|
||
##壁球和合併
|
||
|
||
在合併保持提交歷史記錄清潔的PR時，我們使用<kcd> Squash和merge </ kcd>選項。
|
||
|
||
！[GIF - 壁球和合併]（https://files.gitter.im/FreeCodeCamp/Contributors/56MQ/9cb8db153d7bb1b3576cd1ffc207e39d.gif）
|
||
|
||
###過濾PR
|
||
|
||
> PR，Open，Oldest First，Travis CI建立成功，沒有人分配，沒有評論
|
||
|
||
[`是：pr is：open sort：updated-asc status：success no：assignee comments：0`]（https://github.com/freeCodeCamp/freeCodeCamp/pulls?utf8=%E2%9C%93&q=is% 3Apr％圖20是％3Aopen％20sort％3Aupdated-ASC％20status％3Asuccess％20no％3Aassignee％20comments％3A0）
|
||
|
||
> PR，Open，Oldest First，沒有標籤：`platform`，`enhancement`，`invalid`或`change changes'
|
||
|
||
[`是：pr是：open sort：updated-asc -label：platform -label：enhancement -label：invalid -label：“changes requested”“]（https://github.com/freeCodeCamp/freeCodeCamp/pulls?utf8 =％E2％9C％93＆q =是％3Apr％圖20是％3Aopen％20sort％3Aupdated-ASC％20-標記％3Aplatform％20-標記％3Aenhancement％20-標記％3Ainvalid％20-標籤％3A％22changes％20requested％ 22）。
|
||
|
||
###模板
|
||
|
||
>您可以使用GitHub內置的[**已保存回复**]（https://github.com/settings/replies/）功能製作您自己的功能，或使用以下功能。
|
||
|
||
＃＃＃＃ 謝謝
|
||
|
||
```降價
|
||
感謝您對該頁面的貢獻！ 👍
|
||
我們很高興接受這些變化，並期待未來的貢獻。 🎉
|
||
```
|
||
|
||
####謝謝你，恭喜你
|
||
|
||
>感謝和鼓勵第一次貢獻者。
|
||
|
||
```降價
|
||
嗨@username。恭喜你的第一次拉動請求（PR）！ 🎉
|
||
|
||
感謝您對該頁面的貢獻！ 👍
|
||
我們很高興接受這些變化，並期待未來的貢獻。 📝
|
||
```
|
||
|
||
####構建錯誤
|
||
|
||
```降價
|
||
嘿@username
|
||
|
||
因此，我希望能夠合併您的更改，但看起來Travis CI版本存在錯誤。 ⚠️
|
||
|
||
解決這些問題後，我將能夠審核您的PR並將其合併。 😊
|
||
|
||
---
|
||
|
||
>請隨意參考[文章指南撰寫文章]（https://github.com/freeCodeCamp/freeCodeCamp#article-title），以便正確格式化文章，以便Travis CI構建通過。 ✅
|
||
>
|
||
>此外，GitHub在創建PR時寫下您的更改的簡要說明是一種很好的做法。 📝
|
||
```
|
||
|
||
####同步Fork
|
||
|
||
>當PR與`master`分支不同時。
|
||
|
||
``````降價
|
||
嘿@username
|
||
|
||
因此，我希望能夠合併您的更改，但看起來Travis CI版本存在錯誤。 ⚠️
|
||
|
||
```慶典
|
||
錯誤：ENOTDIR：不是目錄，打開'src / pages / java / data-abstraction / index.md'
|
||
```
|
||
|
||
這個特殊錯誤實際上並不是由您的文件引起的，而是由於將錯誤代碼合併到`master`分支引起的舊錯誤。它已經解決了。
|
||
|
||
要傳遞構建，您必須同步來自`freeCodeCamp / freeCodeCamp` repo的`master`分支的最新更改。
|
||
|
||
使用命令行，您可以通過三個簡單的步驟完成此操作：
|
||
|
||
```慶典
|
||
git remote add upstream git：//github.com/freeCodeCamp/freeCodeCamp.git
|
||
|
||
git fetch upstream
|
||
|
||
git pull上游大師
|
||
```
|
||
|
||
如果你正在使用GUI，你只需“添加一個新的遠程...”並使用上面的鏈接`git：// github.com / freeCodeCamp / freeCodeCamp.git`。
|
||
|
||
一旦你同步你的fork並傳遞構建，我將能夠檢查你的PR並合併它。 😊
|
||
|
||
---
|
||
|
||
>隨意參考GitHub上的[Syncing a Fork]（https://help.github.com/articles/syncing-a-fork/）文章，了解如何讓您的叉子與最新版本保持同步上游存儲庫。 🔄
|
||
>
|
||
>此外，GitHub在創建PR時寫下您的更改的簡要說明是一種很好的做法。 📝
|
||
``````
|
||
|
||
####合併衝突
|
||
|
||
>當PR出現需要解決的合併衝突時.¹
|
||
|
||
```降價
|
||
嘿@username
|
||
|
||
所以我希望能夠合併您的更改，但看起來您有一些合併衝突。 ⚠️
|
||
|
||
解決這些衝突後，我將能夠檢查您的PR並將其合併。 😊
|
||
|
||
---
|
||
|
||
>如果您不熟悉合併衝突過程，請隨時查看GitHub關於[“解決合併衝突”的指南]（https://help.github.com/articles/resolving-a-merge-conflict-上的github /）。 🔍️
|
||
>
|
||
>此外，GitHub在創建PR時寫下您的更改的簡要說明是一種很好的做法。 📝
|
||
```
|
||
¹如果第一次撰稿人有合併衝突，維護人員將為他們解決衝突。
|
||
|
||
####複製
|
||
|
||
> PR重複或重複時。
|
||
|
||
```降價
|
||
嘿@username
|
||
|
||
對於您正在編輯的這篇文章，似乎已經接受了類似的更改，對此抱歉。 😓
|
||
|
||
如果您覺得還有更多要添加的內容，請隨時打開新的PR。
|
||
|
||
再次感謝！ 😊
|
||
|
||
---
|
||
|
||
>如果您有任何疑問，請隨時通過[Gitter]（https://gitter.im/FreeCodeCamp/Contributors）或通過以下評論與您聯繫。 💬
|
||
```
|
||
|
||
####關閉無效的拉取請求
|
||
|
||
> PR無效時。
|
||
|
||
```降價
|
||
嘿@username
|
||
|
||
你實際上沒有添加任何內容，所以我將無效拉請求此PR並將其標記為“無效”。 😓️
|
||
|
||
隨意打開另一個公關！ 👍
|
||
```
|