參與此文件
感謝您對我們的文件感興趣!
使用 GitHub 參與此文件,而不必將存放庫複製到您的桌面。 這是在此存放庫中建立提取要求最簡單的方式。 使用這個方法建立不會牽涉到程式碼變更的次要變更。 使用此方法可讓您一次參與一篇文章。
- 在 GitHub 上尋找您想要參與的文章。
- 當您在 GitHub 中的文章時,登入 GitHub (取得免費帳戶 加入 GitHub)。
- 選擇鉛筆圖示 (編輯此專案分岔中的檔案) 並在 [編輯檔案] 視窗中<>進行變更。
- 捲動到底端,然後輸入描述。
- 選擇 [建議檔案變更]**** > [建立提取要求]****。
您現在已成功提交提取要求。 通常會在 10 個工作天內檢閱提取要求。
使用 Git 以參與實質性的變更,例如:
- 參與程式碼。
- 參與會影響意義的變更。
- 參與文字的大量變更。
- 新增主題。
如果您沒有 GitHub 帳戶,請在 GitHub 設定一個帳戶。
有帳戶之後,在您的電腦上安裝 Git。 請遵循 [設定 Git] 教學課程中的步驟。
若要使用 Git 提交提取要求,請依照 使用 GitHub、Git 和這個存放庫 中的步驟進行。
如果您有下列項目,系統會要求您簽署參與者的許可協定:
- 是 Microsoft 公開技術群組的成員。
- 不是為 Microsoft 工作的參與者。
身為社群成員,您必須先簽署參與者授權合約 (CLA) 才可以參與專案的大型提交。 您只需要完成並提交該文件一次。 仔細檢閱文件。 您可能必須要求您的雇主簽署此文件。
簽署 CLA 不會將認可主要存放庫的權限授與您,但是確實表示 Office 開發人員和 Office 開發人員內容發佈小組可以檢閱和核准您的參與。 您的提交會為您提供信用額度。
通常會在 10 個工作天內檢閱提取要求。
注意
本節中的大部分資訊都可以在 [GitHub 說明] 文章中找到。 如果您熟悉 Git 和 GitHub,請跳至參與及編輯內容一節,以取得此存放庫之程式碼/內容流程的專屬詳細資料。
設定 GitHub 帳戶,讓您可以參與這個專案。 如果您還沒有這麼做,請移至 GitHub,並且立即執行這個操作。
在您的電腦上安裝 Git。 請遵循 [設定 Git] 教學課程中的步驟。
建立您自己的此存放庫分支。 若要這樣做,請在頁面頂端選擇 [分支]**** 按鈕。
將分支複製到您的電腦。 若要這樣做,請開啟 Git Bash。 在命令提示字元中,輸入:
git clone https://github.com/<your user name>/<repo name>.git
接下來,輸入以下命令來建立根存放庫的參考︰
cd <repo name>
git remote add upstream https://github.com/OfficeDev/<repo name>.git
git fetch upstream
恭喜您! 您現在已設定您的存放庫。 您不需要再重複這些步驟。
若要讓參與程序盡可能完美,請依照下列步驟執行。
- 建立新的分支。
- 新增內容或編輯現有內容。
- 將提取要求提交至主要存放庫。
- 刪除分支。
重要事項:將每個分支限制為單一概念/文章,以簡化工作流程,並降低合併衝突的機會。 適合新分支的內容包括︰
- 新文章。
- 拼字檢查和文法編輯。
- 跨一大組文章套用單一格式設定變更 (例如,套用新的著作權頁尾)。
- 開啟 Git Bash。
- 在 Git Bash 命令提示字元中,輸入
git pull upstream main:<new branch name>
。 這會在本機建立從最新 OfficeDev 主要分支複製的新分支。 - 在 Git Bash 命令提示字元中,輸入
git push origin <new branch name>
。 這會警示 GitHub 到新的分支。 現在,您應該會在 GitHub 上存放庫的分支 (fork) 中看到新的分支 (branch)。 - 在 Git Bash 命令提示字元中,輸入
git checkout <new branch name>
以切換至新的分支。
使用檔案總管在您的電腦上瀏覽至存放庫。 存放庫檔案位於 C:\Users\<yourusername>\<repo name>
。
若要編輯檔案,在您選擇的編輯器中開啟它們,並加以修改。 若要建立新的檔案,請使用您選擇的編輯器,並且將新的檔案儲存在存放庫之本機複本中的適當位置。 在工作時,請經常儲存您的工作。
C:\Users\<yourusername>\<repo name>
中的檔案,是您在本機存放庫中所建立之新分支的工作複本。 變更此資料夾中的任何項目並不會影響本機存放庫,直到您認可變更。 若要認可本機存放庫的變更,請在 GitBash 中輸入下列命令︰
git add .
git commit -v -a -m "<Describe the changes made in this commit>"
命令會 add
將您的變更新增至預備區域,以準備將變更認可至存放庫。 命令之後的 add
期間會指定您想要暫存您新增或修改的所有檔案,並以遞歸方式檢查子資料夾。 (如果您不想認可所有變更,您可以新增特定檔案。您也可以復原認可。如需說明,請輸入 git add -help
或 git status
.)
commit
命令會將暫存的變更套用至存放庫。 參數 -m
表示您在命令列中提供認可註解。 -v 和 -a 參數可以略過。 -v 參數適用於命令的詳細資訊輸出,-a 參數會執行您已使用新增命令執行的工作。
您可以在執行工作時認可多次,或者可以在完成時認可一次。
當您完成您的工作,並且準備將它合併到主要存放庫時,請依照下列步驟執行。
- 在 Git Bash 命令提示字元中,輸入
git push origin <new branch name>
。 在您的本機存放庫中,origin
是指您的 GitHub 存放庫,它是本機存放庫的複製來源。 這個命令會推送新分支的目前狀態,包括先前步驟中對 GitHub 分支的所有認可。 - 在 GitHub 網站上,在分支 (fork) 中瀏覽至新的分支 (branch)。
- 在頁面頂端選擇 [提取要求]**** 按鈕。
- 請確認基底分支是
OfficeDev/<repo name>@main
,標頭分支是<your username>/<repo name>@<branch name>
。 - 選擇 [更新認可範圍]**** 按鈕。
- 將標題新增至您的提取要求,並且描述您所做的所有變更。
- 提交提取要求。
其中一個網站系統管理員會處理您的提取要求。 您的提取要求會顯示在 OfficeDev/存放庫名稱 網站的 [問題] 下方。 當提取要求被接受時,就會解決問題。
在成功合併分支之後 (也就是您的提取要求被接受),不要繼續在該本機分支中工作。 如果您提交另一個提取要求,這會導致合併衝突。 若要執行另一個更新,請從成功合併的上游分支,建立新的本機分支,然後再刪除初始本機分支。
例如,如果您的本機分支 X 已成功合併到 OfficeDev/microsoft-graph-docs 主要分支,而且您想要對合併的內容進行其他更新。 從 OfficeDev/microsoft-graph-docs 主要分支建立新的本機分支 X2。 若要這樣做,請開啟 GitBash 然後執行下列命令︰
cd microsoft-graph-docs
git pull upstream main:X2
git push origin X2
您現在已在新的本機分支中 (本機複本,) 您在分支 X 中提交的工作。X2 分支也包含其他寫入器已合併的所有工作,因此如果您的工作相依於其他人的工作 (例如,共用映射) ,則可在新的分支中使用。 您可以簽出新的分支,以確認您先前的工作 (和其他人的工作) 位於分支中...
git checkout X2
...並驗證內容。 (命令 checkout
會將 中的檔案 C:\Users\<yourusername>\microsoft-graph-docs
更新為 X2 分支的目前狀態。) 當您簽出新分支之後,您可以更新內容,並照常認可。 不過,若要避免在合併分支 (X) 中工作,最好刪除它 (請參閱下列刪除 分支 一節) 。
一旦您的變更成功合併到主要存放庫,刪除您使用的分支,因為您已不再需要它。 任何其他工作應該在新的分支中完成。
- 在 Git Bash 命令提示字元中,輸入
git checkout main
。 這可確保您不是在要刪除的分支中 (這是不允許的)。 - 接下來,在命令提示字元中輸入
git branch -d <branch name>
。 只有在已成功合併至上游存放庫時,才會刪除您電腦上的分支。 (您可以使用 旗標覆寫此行為–D
,但請務必先執行此動作。) - 最後,在命令提示字元中輸入
git push origin :<branch name>
(在冒號前面有空格,在冒號後面沒有空格)。 這將會在 github 分支上刪除分支。
恭喜,您已經成功參與專案!
此存放庫中的所有文章都使用 Markdown。 您可以在 [Daring Fireball - Markdown] 找到所有語法) 的完整簡介 (和清單。
請參閱參與者指南中的 Docs Markdown 參考 。
填妥加入 GitHub 的表單以開啟免費 GitHub 帳戶。
如果您的提取要求需要,系統會自動通知您必須簽署參與者許可協定 (CLA) 。
身為社群成員,您必須先簽署參與者授權合約 (CLA) 才可以參與此專案的大型提交。 您只需要完成並提交該文件一次。 仔細檢閱文件。 您可能必須要求您的雇主簽署此文件。
當您透過提取要求提交您的變更時,我們的小組將會收到通知,並且會檢閱您的提取要求。 您會收到來自 GitHub 的提取要求相關通知;如果我們需要更多資訊,我們小組中的人員也可能會通知您。 如果您的提取要求已核准,我們將更新檔。 基於法律、樣式、明確性和其他問題,我們保留編輯您的提交的權利。
目前,我們不允許外部參與者來核准此存放庫中的提取要求。
通常會在 10 個工作天內檢閱提取要求。
- 若要深入瞭解 Markdown,請移至 Markdown 建立者的網站 [Daring Fireball]。
- 若要深入瞭解如何使用 Git 和 GitHub,請先參閱 [GitHub 說明]。
GitHub HomeGitHub 說明設定 GitDaring Fireball - MarkdownDaring Fireball