mirror of
https://github.com/LucasVbr/first-contributions.git
synced 2026-05-13 17:21:50 +00:00
Roshan Jossy
142 lines
9.6 KiB
Markdown
142 lines
9.6 KiB
Markdown
[](https://github.com/ellerbrock/open-source-badges/)
|
||
[](https://opensource.org/licenses/MIT)
|
||
[](https://www.codetriage.com/roshanjossey/first-contributions)
|
||
|
||
# 第一次參與開源
|
||
|
||
萬事起頭難。特別是和其他人合作時，犯錯格外令人不舒服。不過，開源的本質就是和其他人合作。我們希望為初學者帶來一個簡單的方法來學習及參與開源項目。
|
||
|
||
閱讀文章和觀看教學會有所幫助。不過，有什麼方法能比在不會弄亂任何東西的情況下，實際動手做來得更好？本項目旨在指導初學者及簡化初學者參與開源的方式。記住：過程越輕鬆，學習效益越高。如果妳/你想要做出第一次貢獻，只需按照以下簡單步驟操作即可。跟你保證，這會很好玩 :)
|
||
|
||
#### _如果你不喜歡使用指令列，[這裡有使用圖形界面工具的教學。](#使用其他工具的教學)_
|
||
|
||
<img align="right" width="300" src="https://firstcontributions.github.io/assets/Readme/fork.png" alt="fork this repository" />
|
||
|
||
如果你的電腦上尚未安裝 git，請按照這個[安裝指南（英文）](https://help.github.com/articles/set-up-git/)進行安裝。
|
||
|
||
## 分叉（Fork）本儲存庫
|
||
|
||
點選圖示中的按鈕來 Fork 這個 Git 儲存庫。
|
||
這個操作會將儲存庫分叉到你/妳的 GitHub 帳號下。
|
||
|
||
## 複製（Clone）儲存庫
|
||
|
||
<img align="right" width="300" src="https://firstcontributions.github.io/assets/Readme/clone.png" alt="clone this repository" />
|
||
|
||
接下來，將複製後的儲存庫複製到你/妳的電腦上。點選圖示中的綠色按鈕，接著點選複製到剪貼簿按鈕（將儲存庫網址複製下來）
|
||
|
||
隨後打開命令列視窗，輸入如下 git 命令：
|
||
|
||
```bash
|
||
git clone "url you just copied"
|
||
```
|
||
|
||
"url you just copied"（去掉雙引號）就是複製到妳/你帳戶名下的儲存庫網址。取得這網址的方法請見上一步。
|
||
|
||
<img align="right" width="300" src="https://firstcontributions.github.io/assets/Readme/copy-to-clipboard.png" alt="copy URL to clipboard" />
|
||
|
||
譬如：
|
||
|
||
```bash
|
||
git clone https://github.com/<this-is-you>/first-contributions.git
|
||
```
|
||
|
||
'this-is-you' 指的就是你/妳的 GitHub 用戶名。這一步會將你/妳的 first-contributions 儲存庫複製到你的電腦上。
|
||
|
||
## 新建一個分支（Branch）
|
||
|
||
下面的命令能在命令行窗口中，把目錄切換到 first-contributions。
|
||
|
||
```bash
|
||
cd first-contributions
|
||
```
|
||
|
||
接下來使用 `git switch` 命令建立一個程式碼分支：
|
||
|
||
```bash
|
||
git switch -c <add-your-name>
|
||
```
|
||
|
||
譬如：
|
||
|
||
```bash
|
||
git switch -c add-david
|
||
```
|
||
|
||
（新分支的名稱不一定需要有 _add_。然而，在這個新分支的名稱加入 _add_ 是一件合理的事情，因為這個分支的目的是將妳/你的名字添加到貢獻者列表中。）
|
||
|
||
## 對程式碼進行修改，然後提交 (Commit) 修改
|
||
|
||
使用妳/你喜歡的編輯器打開 `Contributors.md` 這個文件，將自己的名字加在檔案最下面，然後存檔。在命令窗口執行 `git status`，這會列出被更動的文件。接著 `git add` 這命令則可以添加更動項目到分支裡，就像以下這條命令。
|
||
|
||
<img align="right" width="450" src="https://firstcontributions.github.io/assets/Readme/git-status.png" alt="git status" />
|
||
|
||
```bash
|
||
git add Contributors.md
|
||
```
|
||
|
||
現在就可以使用 `git commit` 命令 commit（提交）你/妳的修改了。
|
||
|
||
```bash
|
||
git commit -m "Add <your-name> to Contributors list"
|
||
```
|
||
|
||
將 `<your-name>` 替換為自己的名字
|
||
|
||
## 將更動發佈（Push）到 GitHub
|
||
|
||
使用 `git push` 命令發佈代碼
|
||
|
||
```bash
|
||
git push origin <add-your-name>
|
||
```
|
||
|
||
將 `<add-your-name>` 替換為之前新建的分支名稱。
|
||
|
||
<details>
|
||
<summary> <strong>如果在發佈（push）過程中出錯誤（error），點擊這裡</strong> </summary>
|
||
|
||
- ### 身份驗證錯誤（Authentication Error）
|
||
<pre>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/'</pre>
|
||
去 [GitHub's tutorial](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account) 學習如何生成新的 SSH 密匙以及配置。
|
||
|
||
</details>
|
||
|
||
## 提出 Pull Request 將你/妳的修改供他人審閱
|
||
|
||
前往先前自己 Fork 的 GitHub 儲存庫，會看到一個 `Compare & pull request` 的按鈕，點選該按鈕。
|
||
|
||
<img style="float: right;" src="https://firstcontributions.github.io/assets/Readme/compare-and-pull.png" alt="create a pull request" />
|
||
|
||
接著再點選 `Create pull request` 按鈕，正式提交 pull request。
|
||
|
||
<img style="float: right;" src="https://firstcontributions.github.io/assets/Readme/submit-pull-request.png" alt="submit pull request" />
|
||
|
||
不久之後，如果妳/你更改的文件與原本沒有衝突，我們會把所有的變化合併到這個項目的主分支。
|
||
變更合併後，妳/你會收到通知 email。
|
||
|
||
## 下一步？
|
||
|
||
在[這個網站](https://firstcontributions.github.io/#social-share)慶祝妳/你的成就並跟朋友及追隨者分享。
|
||
|
||
如果有任何疑問或想獲得更多協助，歡迎加入我們的 [Slack](https://join.slack.com/t/firstcontributors/shared_invite/zt-1hg51qkgm-Xc7HxhsiPYNN3ofX2_I8FA)
|
||
|
||
現在就動手為其他專案貢獻你/妳的心力。我們整理了一個清單，裡面的專案都有簡單的議題可以著手。[去看看吧！](https://firstcontributions.github.io/#project-list)
|
||
|
||
### [ 更多資料 ](../additional-material/git_workflow_scenarios/additional-material.md)
|
||
|
||
## 使用其他工具的教學
|
||
|
||
| <a href="../gui-tool-tutorials/github-desktop-tutorial.md"><img alt="GitHub Desktop" src="https://desktop.github.com/images/desktop-icon.svg" width="100"></a> | <a href="../gui-tool-tutorials/github-windows-vs2017-tutorial.md"><img alt="Visual Studio 2017" src="https://upload.wikimedia.org/wikipedia/commons/c/cd/Visual_Studio_2017_Logo.svg" width="100"></a> | <a href="../gui-tool-tutorials/gitkraken-tutorial.md"><img alt="GitKraken" src="https://firstcontributions.github.io/assets/gui-tool-tutorials/gitkraken-tutorial/gk-icon.png" width="100"></a> | <a href="../gui-tool-tutorials/github-windows-vs-code-tutorial.md"><img alt="VS Code" src="https://upload.wikimedia.org/wikipedia/commons/1/1c/Visual_Studio_Code_1.35_icon.png" width=100></a> | <a href="../gui-tool-tutorials/sourcetree-macos-tutorial.md"><img alt="Sourcetree App" src="https://wac-cdn.atlassian.com/dam/jcr:81b15cde-be2e-4f4a-8af7-9436f4a1b431/Sourcetree-icon-blue.svg" width=100></a> | <a href="../gui-tool-tutorials/github-windows-intellij-tutorial.md"><img alt="IntelliJ IDEA" src="https://upload.wikimedia.org/wikipedia/commons/thumb/9/9c/IntelliJ_IDEA_Icon.svg/512px-IntelliJ_IDEA_Icon.svg.png" width=100></a> |
|
||
| -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||
| [GitHub Desktop](../gui-tool-tutorials/github-desktop-tutorial.md) | [Visual Studio 2017](../gui-tool-tutorials/github-windows-vs2017-tutorial.md) | [GitKraken](../gui-tool-tutorials/gitkraken-tutorial.md) | [Visual Studio Code](../gui-tool-tutorials/github-windows-vs-code-tutorial.md) | [Atlassian Sourcetree](../gui-tool-tutorials/sourcetree-macos-tutorial.md) | [IntelliJ IDEA](../gui-tool-tutorials/github-windows-intellij-tutorial.md) |
|
||
|
||
<p>項目支持者:</p>
|
||
<p>
|
||
<a href="https://www.digitalocean.com/">
|
||
<img src="https://opensource.nyc3.cdn.digitaloceanspaces.com/attribution/assets/SVG/DO_Logo_horizontal_blue.svg" width="201px">
|
||
</a>
|
||
</p>
|