為 openvela 做出貢獻

[ English | 简体中文 | 繁體中文 ]

openvela 由一支活躍的軟體工程師和研究人員團隊開發。歡迎您加入 openvela 開源社區，為改進此專案做出任何貢獻！ openvela 主要遵循 Apache License 2.0 許可證，具體請參看 LICENSE 檔案。

簽署貢獻者許可協議 (CLA)

為了參與社區貢獻，首次提交程式碼時，需要簽署相應的貢獻者許可協議（Contributor License Agreement, CLA）。以下是針對不同平台的具體步驟：

Gitee 平台：
- 請訪問 Gitee CLA 簽署頁面完成簽署。
- 您可以透過我簽署的 CLA 查看簽署狀態。
GitHub 平台：
- 在提交新的 Pull Request (PR) 後，系統會提示您完成 CLA 的簽署。請根據提示操作以完成簽署流程。

錯誤報告

如果您認為在 openvela 中發現了錯誤，請首先確保您已使用了最新版本的 openvela 進行了測試（您的問題可能已得到修復）。如果未解決，請搜索問題列表，查看是否已有類似的問題。

功能請求

請提交一個 Issue，描述您希望添加的功能、您需要它的原因以及預期的工作方式。

提交程式碼

如果您想給 openvela 增加新功能或者修復一些錯誤，先確認是否已有類似的問題。如果沒有，請您新建一個問題，與大家討論您的想法。

分支策略

trunk：trunk 分支不接受 pull request。
dev：從 dev 分支 fork 程式碼，並推送 pull request。

提交程式碼前的準備工作

在建立新的 Pull Request 之前，請遵循以下指南。這將有助於加快程式碼的審核與合入週期。

遵循程式碼風格規範：確保您的程式碼提交符合 openvela 程式碼風格檢查指南。在提交前執行本地檢查，可有效避免在持續整合 (CI) 流程中出現不必要的失敗。
添加許可證頭部：為所有新增的檔案添加標準的許可證頭部資訊。
補充單元測試：為您的程式碼變更添加必要且充分的單元測試，以驗證其正確性。
補充整合測試：如果您的變更涉及多個模組的互動，請添加相應的整合測試。
保持提交的原子性：請勿修改與本次變更無關的程式碼。一次提交應聚焦於一個獨立的功能或修復，避免混合不相關的格式化調整或程式碼重排。

提交您的更改

1 測試您的更改

請執行測試套件以確保沒有出現任何問題。

2 簽署貢獻者許可協議

首次提交需完成：簽署貢獻者許可協議，請參考簽署貢獻者許可協議 (CLA)章節。

3 提交程式碼

檢查當前狀態。
```
# 查看工作區狀態
git status
```

暫存更改。

# 添加特定檔案到暫存區
git add path/to/changed/file.cpp
# 或添加所有更改
git add .

提交更改。

# 創建提交
git commit -m "簡明扼要的提交資訊"
# 或使用詳細提交資訊
git commit

配置上游倉庫。

# 顯示現有遠端倉庫地址
git remote -v
# 添加上游遠端倉庫引用（僅首次需要執行）
git remote add upstream git@github.com:open-vela/[repository].git
# 顯示現有遠端倉庫地址（應包含 origin 和 upstream）
git remote -v

獲取最新程式碼並變基。

# 獲取上游倉庫的最新程式碼
git fetch upstream
# 將當前分支變基到最新主分支
git rebase upstream/dev

解決衝突（如有）。

# 檢測衝突狀態（推薦）  
git status                   
# 編輯衝突檔案（如 conflict.cpp），可使用任何編輯器，如 nano、vim、VSCode 等
nano conflict.cpp            
# 標記為已解決  
git add conflict.cpp  
# 解決所有衝突後繼續變基操作
git rebase --continue
# 確認變基完成狀態
git status

強制推送更新：

# 強制推送更新後的分支到您的遠端倉庫
git push --force origin dev

4 創建合入請求

訪問 GitHub 上您的 fork 倉庫。
點擊 New pull request 按鈕。
點擊 Create pull request 創建合入請求。
填寫合入請求資訊。

5 合入請求後續工作

持續監控合入請求的審查意見
及時回應審查者的反饋
如需修改，在同一分支上進行更改並推送