本指南詳細介紹如何從 Fork 到成功提交 Pull Request(PR),適用于首次參與貢獻的開發(fā)者。
?? 目標
幫助開發(fā)者標準化代碼貢獻流程,避免沖突、規(guī)范提交、提高協(xié)作效率。
?? 流程總覽

image.png
?? 詳細操作步驟
Fork 原始項目
點擊 GitHub 項目右上角的 Fork 按鈕,將倉庫復制到你的 GitHub 賬戶。克隆 Fork 倉庫到本地
git clone https://github.com/你的用戶名/項目名.git
cd 項目名
- 添加上游遠程(upstream)
git remote add upstream https://github.com/原作者/項目名.git
git fetch upstream
- 創(chuàng)建功能分支進行開發(fā)
git checkout -b my-feature-branch
請不要在 main 或 master 上直接開發(fā),以便后續(xù)合并清晰。
- 編寫、修改代碼
在本地修改/添加你想提交的功能、修復或文檔。
- 添加并提交改動
git add .
git commit -m "feat: 添加用戶搜索功能 #105"
commit message 寫法建議:
feat: 添加功能
fix: 修復問題
docs: 文檔更新
refactor: 重構(gòu)
test: 測試相關(guān)
chore: 雜項修改
- 同步主分支(避免沖突)
git checkout main
git pull upstream main
git checkout my-feature-branch
git merge main
git add .
git commit -m "chore: 合并主分支最新內(nèi)容"
- 推送功能分支到你自己的遠程倉庫
git push origin my-feature-branch
- 在 GitHub 創(chuàng)建 Pull Request
進入你的 GitHub 倉庫;
點擊 “Compare & pull request”;
目標分支選擇:original-author/main;
來源分支選擇:your-name/my-feature-branch;
填寫 PR 標題、描述,關(guān)聯(lián) Issue(如 Fixes #42);
點擊 “Create Pull Request”。
?? Pull Request 描述模板(可復制)
markdown
git clone https://github.com/你的用戶名/項目名.git
cd 項目名
### ? 改動內(nèi)容
- 添加了用戶搜索功能(支持拼音模糊匹配)
- 重構(gòu)了 searchService 結(jié)構(gòu)
### ?? 關(guān)聯(lián) Issue
Fixes #105
? 測試說明
- 輸入用戶姓名或拼音;
- 搜索結(jié)果實時匹配,兼容多語言。
?? 其他說明
如需設計確認,請聯(lián)系 @設計負責人
?? 提交后你可以:
修改 PR 內(nèi)容(繼續(xù)在分支中提交即可自動更新 PR);
與維護者互動討論;
如果被要求修改,請按建議修改再推送。
?? 最佳實踐建議
每個功能使用獨立分支;
在提交 PR 之前始終同步 upstream/main;
提交信息清晰,描述詳盡;
多與社區(qū)溝通,提前在 issue 中認領(lǐng)任務;
閱讀并遵守項目的 CONTRIBUTING.md 和 CODE_OF_CONDUCT(如果有);