指南：從提交PR到成為核心開發(fā)者)
TheRock開源貢獻(xiàn)指南從提交PR到成為核心開發(fā)者【免費(fèi)下載鏈接】TheRockThe HIP Environment and ROCm Kit - A lightweight open source build system for HIP and ROCm項(xiàng)目地址: https://gitcode.com/gh_mirrors/th/TheRockTheRock作為輕量級(jí)開源構(gòu)建系統(tǒng)為HIP和ROCm提供強(qiáng)大支持。本指南將帶你從提交第一個(gè)PR開始逐步掌握貢獻(xiàn)流程最終成長為核心開發(fā)者助力開源社區(qū)發(fā)展。一、貢獻(xiàn)前準(zhǔn)備快速融入社區(qū)1.1 了解項(xiàng)目架構(gòu)與規(guī)范TheRock項(xiàng)目結(jié)構(gòu)清晰核心代碼位于多個(gè)目錄中。開發(fā)前建議閱讀docs/development/build_system.md了解構(gòu)建系統(tǒng)架構(gòu)以及docs/development/style_guides/中的編碼規(guī)范包括Bash、CMake、GitHub Actions和Python風(fēng)格指南確保代碼符合項(xiàng)目標(biāo)準(zhǔn)。1.2 搭建開發(fā)環(huán)境克隆倉庫使用命令git clone https://gitcode.com/gh_mirrors/th/TheRock獲取源碼安裝依賴根據(jù)docs/environment_setup_guide.md配置環(huán)境關(guān)鍵步驟包括安裝patchelfsudo env INSTALL_PREFIX/usr/local ./dockerfiles/install_pinned_patchelf.sh配置開發(fā)工具推薦使用VSCode參考docs/development/assets/vscode_cmake_tools_project_outline.jpg配置CMake工具提升開發(fā)效率。二、提交PR從零開始的貢獻(xiàn)流程2.1 尋找合適的任務(wù)新手可從good first issue入手這些任務(wù)范圍小、難度低進(jìn)階貢獻(xiàn)者可選擇help wanted標(biāo)簽的任務(wù)解決實(shí)際問題2.2 創(chuàng)建分支與提交代碼分支命名遵循規(guī)范個(gè)人開發(fā)分支格式為users/[USERNAME]/[feature-or-bug-name]例如users/cooldev/fix-cmake-warning提交規(guī)范使用清晰的提交信息參考Conventional Commits格式預(yù)檢查運(yùn)行pre-commit工具確保代碼質(zhì)量pip install pre-commit pre-commit run --all-files2.3 編寫PR描述PR描述需包含以下關(guān)鍵信息關(guān)聯(lián)issue如Fixes #123功能或修復(fù)說明測試方法影響范圍參考skills/therock_pr_bot/FAQ.md#-pr-description了解詳細(xì)要求PR模板位于.github/pull_request_template.md。2.4 提交PR與觸發(fā)CI提交PR后系統(tǒng)會(huì)自動(dòng)運(yùn)行CI檢查。可通過GitHub Actions界面查看構(gòu)建狀態(tài)如圖所示若CI失敗根據(jù)日志修復(fù)問題。關(guān)鍵檢查包括代碼風(fēng)格pre-commit單元測試unit_tests.yml構(gòu)建驗(yàn)證三、PR審核提升貢獻(xiàn)質(zhì)量的關(guān)鍵步驟3.1 理解審核標(biāo)準(zhǔn)審核關(guān)注以下方面代碼質(zhì)量是否符合編碼規(guī)范測試覆蓋是否添加單元測試參考docs/development/adding_tests.md性能影響構(gòu)建時(shí)間、內(nèi)存使用等兼容性是否影響其他模塊3.2 響應(yīng)審核意見及時(shí)回復(fù)評(píng)論清晰解釋設(shè)計(jì)思路根據(jù)反饋修改代碼后使用Re-request review功能通知審核者大型修改建議分多次提交保持PR聚焦3.3 處理CI反饋CI失敗常見原因及解決方法編譯錯(cuò)誤檢查依賴配置參考cmake/therock_subproject.cmake測試失敗查看詳細(xì)日志使用test_tools/determine_rocm_test_dependencies.py分析依賴格式問題運(yùn)行pre-commit run自動(dòng)修復(fù)四、成為核心開發(fā)者持續(xù)貢獻(xiàn)與社區(qū)參與4.1 深化技術(shù)理解學(xué)習(xí)項(xiàng)目核心模塊構(gòu)建系統(tǒng)cmake/therock_subproject.cmake依賴管理build_tools/_therock_utils/artifacts.pyCI流程build_tools/github_actions/configure_multi_arch_ci.py參與架構(gòu)討論關(guān)注RFCs文檔如RFC0012-Repo-Structure.md4.2 擴(kuò)大貢獻(xiàn)范圍維護(hù)子模塊如math-libs/BLAS/中的rocBLAS集成改進(jìn)工具鏈優(yōu)化build_tools/setup_ccache.py等構(gòu)建工具編寫文檔完善docs/development/中的指南幫助新貢獻(xiàn)者4.3 社區(qū)參與在Discord的#therock-contributors頻道交流參與代碼審查幫助其他貢獻(xiàn)者提升PR質(zhì)量定期參加社區(qū)會(huì)議分享貢獻(xiàn)經(jīng)驗(yàn)五、高級(jí)技巧提升貢獻(xiàn)效率5.1 利用AI工具輔助開發(fā)項(xiàng)目支持使用AI工具提升效率參考CLAUDE.md和skills/rocm-pr-quality/中的AI輔助指南。使用時(shí)需確保人工驗(yàn)證AI生成內(nèi)容遵守項(xiàng)目AI使用政策5.2 優(yōu)化構(gòu)建流程使用ccache加速編譯docs/development/ccache_troubleshooting.md本地復(fù)現(xiàn)CI環(huán)境參考docs/development/test_environment_reproduction.md5.3 跟蹤貢獻(xiàn)影響提交PR后可通過CI步驟摘要查看構(gòu)建結(jié)果和測試覆蓋率關(guān)注S3 buckets中的構(gòu)建產(chǎn)物了解貢獻(xiàn)對(duì)下游項(xiàng)目的影響。六、常見問題與解決方案6.1 PR被標(biāo)記為Not ready to Review通常由于描述不完整補(bǔ)充issue鏈接和詳細(xì)說明測試缺失添加單元測試或解釋豁免原因風(fēng)格問題運(yùn)行pre-commit run --all-files修復(fù)6.2 構(gòu)建依賴沖突檢查BUILD_TOPOLOGY.toml中的子項(xiàng)目依賴使用./build_tools/fetch_artifacts.py獲取正確版本的預(yù)構(gòu)建組件6.3 權(quán)限問題外部貢獻(xiàn)者PR可能遇到權(quán)限限制可通過workflow_dispatch觸發(fā)特殊CI在issue中請(qǐng)求核心開發(fā)者協(xié)助測試結(jié)語TheRock社區(qū)歡迎所有開發(fā)者貢獻(xiàn)力量從修復(fù)小bug到參與架構(gòu)設(shè)計(jì)每一份貢獻(xiàn)都至關(guān)重要。遵循本指南你將快速融入社區(qū)逐步成長為核心開發(fā)者共同推動(dòng)HIP和ROCm生態(tài)的發(fā)展。開始你的貢獻(xiàn)之旅吧【免費(fèi)下載鏈接】TheRockThe HIP Environment and ROCm Kit - A lightweight open source build system for HIP and ROCm項(xiàng)目地址: https://gitcode.com/gh_mirrors/th/TheRock創(chuàng)作聲明：本文部分內(nèi)容由AI輔助生成（AIGC），僅供參考 TheRock開源貢獻(xiàn)指南：從提交PR到成為核心開發(fā)者
TheRock開源貢獻(xiàn)指南從提交PR到成為核心開發(fā)者【免費(fèi)下載鏈接】TheRockThe HIP Environment and ROCm Kit - A lightweight open source build system for HIP and ROCm項(xiàng)目地址: https://gitcode.com/gh_mirrors/th/TheRockTheRock作為輕量級(jí)開源構(gòu)建系統(tǒng)為HIP和ROCm提供強(qiáng)大支持。本指南將帶你從提交第一個(gè)PR開始逐步掌握貢獻(xiàn)流程最終成長為核心開發(fā)者助力開源社區(qū)發(fā)展。一、貢獻(xiàn)前準(zhǔn)備快速融入社區(qū)1.1 了解項(xiàng)目架構(gòu)與規(guī)范TheRock項(xiàng)目結(jié)構(gòu)清晰核心代碼位于多個(gè)目錄中。開發(fā)前建議閱讀docs/development/build_system.md了解構(gòu)建系統(tǒng)架構(gòu)以及docs/development/style_guides/中的編碼規(guī)范包括Bash、CMake、GitHub Actions和Python風(fēng)格指南確保代碼符合項(xiàng)目標(biāo)準(zhǔn)。1.2 搭建開發(fā)環(huán)境克隆倉庫使用命令git clone https://gitcode.com/gh_mirrors/th/TheRock獲取源碼安裝依賴根據(jù)docs/environment_setup_guide.md配置環(huán)境關(guān)鍵步驟包括安裝patchelfsudo env INSTALL_PREFIX/usr/local ./dockerfiles/install_pinned_patchelf.sh配置開發(fā)工具推薦使用VSCode參考docs/development/assets/vscode_cmake_tools_project_outline.jpg配置CMake工具提升開發(fā)效率。二、提交PR從零開始的貢獻(xiàn)流程2.1 尋找合適的任務(wù)新手可從good first issue入手這些任務(wù)范圍小、難度低進(jìn)階貢獻(xiàn)者可選擇help wanted標(biāo)簽的任務(wù)解決實(shí)際問題2.2 創(chuàng)建分支與提交代碼分支命名遵循規(guī)范個(gè)人開發(fā)分支格式為users/[USERNAME]/[feature-or-bug-name]例如users/cooldev/fix-cmake-warning提交規(guī)范使用清晰的提交信息參考Conventional Commits格式預(yù)檢查運(yùn)行pre-commit工具確保代碼質(zhì)量pip install pre-commit pre-commit run --all-files2.3 編寫PR描述PR描述需包含以下關(guān)鍵信息關(guān)聯(lián)issue如Fixes #123功能或修復(fù)說明測試方法影響范圍參考skills/therock_pr_bot/FAQ.md#-pr-description了解詳細(xì)要求PR模板位于.github/pull_request_template.md。2.4 提交PR與觸發(fā)CI提交PR后系統(tǒng)會(huì)自動(dòng)運(yùn)行CI檢查。可通過GitHub Actions界面查看構(gòu)建狀態(tài)如圖所示若CI失敗根據(jù)日志修復(fù)問題。關(guān)鍵檢查包括代碼風(fēng)格pre-commit單元測試unit_tests.yml構(gòu)建驗(yàn)證三、PR審核提升貢獻(xiàn)質(zhì)量的關(guān)鍵步驟3.1 理解審核標(biāo)準(zhǔn)審核關(guān)注以下方面代碼質(zhì)量是否符合編碼規(guī)范測試覆蓋是否添加單元測試參考docs/development/adding_tests.md性能影響構(gòu)建時(shí)間、內(nèi)存使用等兼容性是否影響其他模塊3.2 響應(yīng)審核意見及時(shí)回復(fù)評(píng)論清晰解釋設(shè)計(jì)思路根據(jù)反饋修改代碼后使用Re-request review功能通知審核者大型修改建議分多次提交保持PR聚焦3.3 處理CI反饋CI失敗常見原因及解決方法編譯錯(cuò)誤檢查依賴配置參考cmake/therock_subproject.cmake測試失敗查看詳細(xì)日志使用test_tools/determine_rocm_test_dependencies.py分析依賴格式問題運(yùn)行pre-commit run自動(dòng)修復(fù)四、成為核心開發(fā)者持續(xù)貢獻(xiàn)與社區(qū)參與4.1 深化技術(shù)理解學(xué)習(xí)項(xiàng)目核心模塊構(gòu)建系統(tǒng)cmake/therock_subproject.cmake依賴管理build_tools/_therock_utils/artifacts.pyCI流程build_tools/github_actions/configure_multi_arch_ci.py參與架構(gòu)討論關(guān)注RFCs文檔如RFC0012-Repo-Structure.md4.2 擴(kuò)大貢獻(xiàn)范圍維護(hù)子模塊如math-libs/BLAS/中的rocBLAS集成改進(jìn)工具鏈優(yōu)化build_tools/setup_ccache.py等構(gòu)建工具編寫文檔完善docs/development/中的指南幫助新貢獻(xiàn)者4.3 社區(qū)參與在Discord的#therock-contributors頻道交流參與代碼審查幫助其他貢獻(xiàn)者提升PR質(zhì)量定期參加社區(qū)會(huì)議分享貢獻(xiàn)經(jīng)驗(yàn)五、高級(jí)技巧提升貢獻(xiàn)效率5.1 利用AI工具輔助開發(fā)項(xiàng)目支持使用AI工具提升效率參考CLAUDE.md和skills/rocm-pr-quality/中的AI輔助指南。使用時(shí)需確保人工驗(yàn)證AI生成內(nèi)容遵守項(xiàng)目AI使用政策5.2 優(yōu)化構(gòu)建流程使用ccache加速編譯docs/development/ccache_troubleshooting.md本地復(fù)現(xiàn)CI環(huán)境參考docs/development/test_environment_reproduction.md5.3 跟蹤貢獻(xiàn)影響提交PR后可通過CI步驟摘要查看構(gòu)建結(jié)果和測試覆蓋率關(guān)注S3 buckets中的構(gòu)建產(chǎn)物了解貢獻(xiàn)對(duì)下游項(xiàng)目的影響。六、常見問題與解決方案6.1 PR被標(biāo)記為Not ready to Review通常由于描述不完整補(bǔ)充issue鏈接和詳細(xì)說明測試缺失添加單元測試或解釋豁免原因風(fēng)格問題運(yùn)行pre-commit run --all-files修復(fù)6.2 構(gòu)建依賴沖突檢查BUILD_TOPOLOGY.toml中的子項(xiàng)目依賴使用./build_tools/fetch_artifacts.py獲取正確版本的預(yù)構(gòu)建組件6.3 權(quán)限問題外部貢獻(xiàn)者PR可能遇到權(quán)限限制可通過workflow_dispatch觸發(fā)特殊CI在issue中請(qǐng)求核心開發(fā)者協(xié)助測試結(jié)語TheRock社區(qū)歡迎所有開發(fā)者貢獻(xiàn)力量從修復(fù)小bug到參與架構(gòu)設(shè)計(jì)每一份貢獻(xiàn)都至關(guān)重要。遵循本指南你將快速融入社區(qū)逐步成長為核心開發(fā)者共同推動(dòng)HIP和ROCm生態(tài)的發(fā)展。開始你的貢獻(xiàn)之旅吧【免費(fèi)下載鏈接】TheRockThe HIP Environment and ROCm Kit - A lightweight open source build system for HIP and ROCm項(xiàng)目地址: https://gitcode.com/gh_mirrors/th/TheRock創(chuàng)作聲明：本文部分內(nèi)容由AI輔助生成（AIGC），僅供參考