Foreword
自前段時(shí)間分享了 Google 的 2019 Season of Docs 項(xiàng)目之后帝火，業(yè)界的一些 Technical Writer (TW) 對(duì)參與開(kāi)源項(xiàng)目的文檔表現(xiàn)出了極大的興趣。
很多小伙伴都希望能夠在業(yè)余時(shí)間了解技術(shù)寫(xiě)作領(lǐng)域新的解決方案 (GitHub + Markdown)湃缎，實(shí)際參與開(kāi)源項(xiàng)目來(lái)親身體驗(yàn)犀填，從而不斷提升自身的技術(shù)寫(xiě)作技能。
然而嗓违，已工作的小伙伴們平時(shí)有日常工作九巡，又擔(dān)心沒(méi)有那么多集中的時(shí)間來(lái)參與 Season of Docs 項(xiàng)目，于是便向我打聽(tīng)怎么參與 PingCAP 的開(kāi)源項(xiàng)目 TiDB蹂季。
這里說(shuō)明一下：PingCAP 是我現(xiàn)在任職的公司冕广，老讀者應(yīng)該都知道。TiDB 是 PingCAP 的一個(gè)開(kāi)源項(xiàng)目偿洁，做的是分布式 NewSQL (HTAP) 數(shù)據(jù)庫(kù)撒汉。
其中一個(gè) TW 妹紙說(shuō)“超級(jí)想在工作外多鍛煉自己”，我也特別開(kāi)心能遇到一些不斷提升自己涕滋、滿滿正能量的人睬辐。于是，我給幾個(gè)找過(guò)來(lái)的同學(xué)承諾宾肺，會(huì)寫(xiě)一個(gè)如何給 TiDB 貢獻(xiàn)文檔的指南溯饵。
其實(shí)，在 GitHub 上 pingcap/community 庫(kù)中爱榕，早已有 Contribution Guide瓣喊，里面描述了命令行版的通用步驟：https://github.com/pingcap/community/blob/master/CONTRIBUTING.md
考慮到大多數(shù)的 Technical Writer 多是語(yǔ)言背景，沒(méi)有任何技術(shù)背景黔酥，如果直接給大家說(shuō)具體步驟的話藻三，可能會(huì)一頭霧水。
所以跪者，建議大家先了解一些 GitHub 和 Markdown 的基礎(chǔ)知識(shí)棵帽，以便于快速上手。這樣渣玲，之后給大家分享具體的操作步驟時(shí)逗概，就不會(huì)感到看得云里霧里了。當(dāng)然忘衍，如果你對(duì) Git 和 GitHub 很熟悉逾苫，可以直接參考命令行版哦~
附上我之前關(guān)于 GitHub 和 Markdown 的分享：
- Markdown：寫(xiě)技術(shù)文檔卿城、個(gè)人博客和讀書(shū)筆記都很好用的輕量級(jí)標(biāo)記語(yǔ)言
- 技術(shù)寫(xiě)作工具 | GitHub + Markdown 的新輕型技術(shù)寫(xiě)作模式速覽
- 技術(shù)文檔方案 | GitHub + Markdown 的深度實(shí)踐解析
需要了解的一些術(shù)語(yǔ)
本文主要介紹一些常用常見(jiàn)的術(shù)語(yǔ)，你也可以去 GitHub 的 Glossary 里查看更多：
- https://help.github.com/en/articles/github-glossary
- https://www.kernel.org/pub/software/scm/git/docs/gitglossary.html
Git
Git 是一個(gè)免費(fèi)的開(kāi)源分布式版本控制系統(tǒng)铅搓，可快速高效地處理各種大小項(xiàng)目瑟押。要了解更多可查看：https://git-scm.com/
該網(wǎng)頁(yè)還提供了免費(fèi)的 Git 相關(guān)的書(shū) Pro Git，可免費(fèi)在線閱讀星掰，有多種語(yǔ)言版本妒御。如果你有興趣深入了解 Git蓝晒，可以看下醒串；如果你沒(méi)興趣了解太多仔引，可以略過(guò)，直接往下看播玖。
GitHub
GitHub 是一個(gè)基于網(wǎng)絡(luò)的提供 Git 版本控制和托管服務(wù)的平臺(tái)椎工。網(wǎng)址為：https://github.com/ 我之前的分享里有較為詳細(xì)的介紹。
我的個(gè)人主頁(yè)是：https://github.com/lilin90黎棠，與 2018 年相比還是有一些小變化晋渺。
Branch
Branch 即分支，可以理解為一個(gè)庫(kù) (repository) 的平行版本脓斩。分支包含在庫(kù)中木西，但是不會(huì)影響主分支 (即 master branch)。通常會(huì)在新建的分支上進(jìn)行內(nèi)容的修改随静，然后再將修改提交到 master 分支上八千。
以 https://github.com/pingcap/docs 為例，其分支如下圖所示：
Commit
Commit 即你的修改燎猛，一個(gè) commit 可以理解為一次改動(dòng)恋捆。
示例如下：
Fork
Fork 的圖標(biāo)是個(gè)叉的形狀，可以理解為復(fù)制一份重绷。通過(guò)點(diǎn)擊 Fork沸停，可以將一個(gè) repository 復(fù)制一份到個(gè)人賬號(hào)下，個(gè)人復(fù)制的倉(cāng)庫(kù)中的修改不會(huì)影響原庫(kù)昭卓。
Issue
如果你有一些優(yōu)化建議愤钾，發(fā)現(xiàn)了一個(gè) bug，或者想反饋一些問(wèn)題候醒，都可以提一個(gè) issue能颁。
Markdown
Markdown 是一種輕量級(jí)標(biāo)記語(yǔ)言，詳細(xì)介紹參考該分享倒淫。
Merge
Merge 即合并伙菊，指將一個(gè) branch 中的修改合并到另一個(gè) branch 中。常見(jiàn)的如將一個(gè) branch 里的修改合并到 master branch 中。GitHub 官方介紹：https://help.github.com/en/articles/merging-a-pull-request
Pull Request
Pull Request 通常簡(jiǎn)稱為 PR镜硕，是指用戶提交的修改申請(qǐng)运翼，一個(gè) Pull Request 里可以包含多個(gè) commit。
Repository
Repository 是 GitHub 上最基本的元素兴枯，可以理解為一個(gè)項(xiàng)目文件夾南蹂。中文里可稱作“倉(cāng)庫(kù)”或“庫(kù)”。Repository 里包含了所有的項(xiàng)目文件念恍，以及每個(gè)文件的修改歷史。它可以是 public 的晚顷，也可以是 private 的峰伙。
Afterword
以上便是一些基本的術(shù)語(yǔ)，并未涵蓋所有该默，有些術(shù)語(yǔ)可以在實(shí)際提 Pull Request 的過(guò)程中更真切地理解瞳氓。比如，Pull 和 Push栓袖，Pull 指將遠(yuǎn)程的修改拉取合并到本地匣摘，Push 則指將本地的修改推到遠(yuǎn)程倉(cāng)庫(kù)。
如果你想?yún)⑴c開(kāi)源項(xiàng)目裹刮，為開(kāi)源項(xiàng)目貢獻(xiàn)文檔音榜，獲得另一種不同的 Technical Writer 體驗(yàn)，拓展自己的技能樹(shù)捧弃，可以先從本文分享的基礎(chǔ)知識(shí)開(kāi)始赠叼。之后，我會(huì)跟大家分享簡(jiǎn)單易上手的 GitHub 客戶端版的操作步驟违霞，讓躍躍欲試的同學(xué)看完就可以行動(dòng)起來(lái)嘴办。
你可能想讀：
技術(shù)文檔誕生記 | 完整的技術(shù)寫(xiě)作流程是怎樣的？
Technical Writer 可提供的交付物有哪些买鸽？
GitHub + Markdown 的新輕型技術(shù)寫(xiě)作模式速覽
GitHub + Markdown 的技術(shù)文檔方案深度解析
Technical Writer 日常工作中好用的小工具
技術(shù)傳播人士應(yīng)該知道的色彩搭配常識(shí)
如何使用顏色來(lái)提高技術(shù)文檔的可讀性涧郊？
Technical Writer 如何 Review 技術(shù)文檔？| 重細(xì)節(jié)+全局觀
技術(shù)翻譯需要有 Technical Writer 的 sense
深度解析關(guān)于技術(shù)翻譯的六個(gè)認(rèn)知誤區(qū)
如何讓你的內(nèi)容輸出更加專業(yè)更有設(shè)計(jì)感眼五？
書(shū)單 | 有哪些技術(shù)傳播從業(yè)者必知必看的書(shū)籍妆艘？
有哪些適合技術(shù)傳播從業(yè)者關(guān)注的優(yōu)質(zhì)博客？（一）
有哪些適合技術(shù)傳播從業(yè)者關(guān)注的優(yōu)質(zhì)博客弹砚？（二）
經(jīng)驗(yàn)分享 | 來(lái)自 11 位 Technical Writer 前輩的職業(yè)發(fā)展建議（上篇）
經(jīng)驗(yàn)分享 | 來(lái)自 11 位 Technical Writer 前輩的職業(yè)發(fā)展建議（下篇）
技術(shù)傳播沙龍精彩分享 | 高校老師與行業(yè)大牛談“互聯(lián)網(wǎng)技術(shù)寫(xiě)作”
英語(yǔ)技術(shù)文檔的標(biāo)題到底該大寫(xiě)還是小寫(xiě)双仍？
不同階段如何應(yīng)對(duì) Technical Writer 的職業(yè)顧慮或煩惱？
如何使用正則表達(dá)式批量添加和刪除字符桌吃？
英語(yǔ)技術(shù)文檔中如何正確使用時(shí)態(tài)朱沃？
英語(yǔ)技術(shù)文檔中如何正確使用人稱？
英語(yǔ)技術(shù)文檔中如何正確使用無(wú)序列表和有序列表？
Markdown：寫(xiě)技術(shù)文檔逗物、個(gè)人博客和讀書(shū)筆記都很好用的輕量級(jí)標(biāo)記語(yǔ)言
如何為 Markdown 文件自動(dòng)生成目錄搬卒？
技術(shù)寫(xiě)作實(shí)例解析 | 簡(jiǎn)潔即是美
兩分鐘趣味解讀 Technical Writer
若脫離理解，直譯得再正確又有何意翎卓？
優(yōu)質(zhì)譯文不應(yīng)止于正確契邀，還要 Well-Organized
Technical Writer 需要 Technical 到會(huì)寫(xiě)代碼嗎？
如何利用 GitHub Pages 和 Hugo 輕松搭建個(gè)人博客失暴？
寫(xiě)在入職技術(shù)型創(chuàng)業(yè)公司 PingCAP 一個(gè)月之后
揭秘 Technical Writer 的工作環(huán)境 | 加入 PingCAP 五個(gè)月的員工體驗(yàn)記
-END-
