Skip to content

Latest commit

 

History

History
172 lines (107 loc) · 10.8 KB

File metadata and controls

172 lines (107 loc) · 10.8 KB

Open Source Love License: MIT Open Source Helpers

第一次參與開源

萬事起頭難。特別是和其他人合作時,犯錯格外令人不舒服。不過,開源的本質就是和其他人合作。我們希望為初學者帶來一個簡單的方法來學習及參與開源項目。

閱讀文章和觀看教學會有所幫助。不過,有什麼方法能比在不會弄亂任何東西的情況下,實際動手做來得更好?本項目旨在指導初學者及簡化初學者參與開源的方式。記住:過程越輕鬆,學習效益越高。如果妳/你想要做出第一次貢獻,只需按照以下簡單步驟操作即可。跟你保證,這會很好玩 :)

如果你不喜歡使用指令列,這裡有使用圖形界面工具的教學。

分叉本儲存庫

如果你的電腦上尚未安裝 git,請按照這個安裝指南(英文)進行安裝。

分叉(Fork)本儲存庫

點選圖示中的按鈕來 Fork 這個 Git 儲存庫。 這個操作會將儲存庫分叉到你/妳的 GitHub 帳號下。

複製(Clone)儲存庫

複製本儲存庫

接下來,將分叉後的儲存庫複製到你/妳的電腦上。前往你/妳的GitHub帳號,打開分叉到帳號下的儲存庫,點選圖示中的綠色按鈕,接著在SSH分頁上點選複製到剪貼簿按鈕(將儲存庫網址複製下來)。

隨後打開命令列視窗,輸入如下 git 命令:

git clone "url you just copied"

"url you just copied"(去掉雙引號)就是複製到妳/你帳戶名下的儲存庫網址。取得這網址的方法請見上一步。

複製連結到剪貼簿

譬如:

git clone git@github.com:this-is-you/first-contributions.git

this-is-you 指的就是你/妳的 GitHub 用戶名。這一步會將你/妳的 first-contributions 儲存庫複製到你的電腦上。

新建一個分支(Branch)

下面的命令能在命令行窗口中,把目錄切換到 first-contributions(如果你/妳尚未切換到該目錄):

cd first-contributions

接下來使用 git switch 命令建立一個分支:

git switch -c your-new-branch-name

譬如:

git switch -c add-david

(新分支的名稱不一定需要有 add。然而,在這個新分支的名稱加入 add 是一件合理的事情,因為這個分支的目的是將妳/你的名字添加到貢獻者列表中。)

如果在使用 git switch 命令的過程中出現錯誤(error),點擊這裡:

如果顯示錯誤訊息 "Git: switch is not a git command. See git –help",這可能是因為你/妳使用的是舊版的 git。

在這種情況下,請改為使用 git checkout 命令:

git checkout -b your-new-branch-name

對程式碼進行修改,然後提交 (Commit) 修改

使用妳/你喜歡的編輯器打開 Contributors.md 這個文件,將自己的名字加在檔案中,不要將其添加到文件的開頭或結尾。將其新增至文件中間的任意位置,然後存檔。

被更動的文件

在命令窗口執行 git status,這會列出被更動的文件。

接著 git add 這命令則可以添加更動項目到分支裡,就像以下這條命令:

git add Contributors.md

現在就可以使用 git commit 命令 commit(提交)你/妳的修改了:

git commit -m "Add your-name to Contributors list"

your-name 替換為自己的名字。

將更動發佈(Push)到 GitHub

使用 git push 命令發佈代碼:

git push -u origin your-branch-name

your-branch-name 替換為之前新建的分支名稱。

如果在發佈(push)過程中出現錯誤(error),點擊這裡:
  • 身份驗證錯誤(Authentication Error)

    remote: Support for password authentication was removed on August 13, 2021. Please use a personal access token instead.
    remote: Please see https://github.blog/2020-12-15-token-authentication-requirements-for-git-operations/ for more information.
    fatal: Authentication failed for 'https://github.com/<your-username>/first-contributions.git/'

    GitHub's tutorial 學習如何生成新的 SSH 密匙以及配置。

    此外,你/妳可能需要執行 'git remote -v' 來檢查遠端儲存庫的URL。

    如果看起來與這樣有一點相似:

    origin	https://github.com/your-username/your_repo.git (fetch)
    origin	https://github.com/your-username/your_repo.git (push)

    使用以下命令更改它:

    git remote set-url origin git@github.com:your-username/your_repo.git

    否則,你/妳仍會收到要求輸入使用者名稱和密碼的提示,並出現身份驗證錯誤。

提出 Pull Request 將你/妳的修改供他人審閱

前往你/妳的GitHub帳號,打開分叉到帳號下的儲存庫,會看到一個 Compare & pull request 的按鈕,點選該按鈕。

建立一個 pull request

接著再點選 Create pull request 按鈕,正式提交 pull request。

提出 pull request

不久之後,如果妳/你更改的文件與原本沒有衝突,我們會把所有的變化合併到這個項目的主分支。 變更合併後,妳/你會收到通知 email。

下一步?

恭喜!妳/你剛剛完成了作為一個貢獻者會經常使用的標準工作流程:fork -> clone -> edit -> pull request

這個網站慶祝妳/你的貢獻並跟朋友及追隨者分享。

如果你想要更多練習,請看 code contributions

現在就動手為其他專案貢獻你/妳的心力。我們整理了一個清單,裡面的專案都有簡單的議題可以著手。去看看吧!

使用其他工具的教學

GitHub Desktop Visual Studio 2017 GitKraken VS Code Sourcetree App IntelliJ IDEA
GitHub Desktop Visual Studio 2017 GitKraken Visual Studio Code Atlassian Sourcetree IntelliJ IDEA

項目支持者: