貢獻指南
共建開源
開源需要大家一起來支持,支持的方式有很多種,比如使用、推薦、寫教程、保護生態、貢獻代碼、回答問題、分享經驗等;歡迎您加入我們!
倉庫地址
請不要貢獻到 Gitee 倉庫,Gitee提交的代碼會被Github倉庫覆蓋、而且貢獻人列表也不會出現您的名字
Github
Gitee
你可以做什麼
關注 issues 動態
- 我們會在 issues 中發佈一些待開發的功能,如果你感興趣,可以在 issues 中留言,我們會盡快回復。
- 評論回覆幫助提出疑問的用户;
- 根據issues內容,提出合理的解決方案;去修復bug或者實現功能,並以 pull request 形式提交至 MineAdmin 倉庫
- 關注自己提交 Pull Request 的進度和狀態,以推動您的 Pull Request 儘快合入主倉庫;
- 對其他人提交的 Pull Request 進行 Code Review,並給出您的建議和看法。
- 根據他人或自己的需求,研發獨立的功能組件;
- 完善文檔,提供更好的使用説明。
Pull Request 指南
雖然我們會定期發佈一些待開發的功能,但是我們更歡迎你自己提出你想要實現的功能。你可以在 issues 中提出你的想法,我們會盡快回復是否接受。 在提交問題之前,請檢查是否已經發布了類似的問題。
- fork 本倉庫到你的 Github 賬號下;
- 提交信息的格式應為 [File Name]: Info about commit. (例如) README.md: Fix xxx bug
- 提交代碼前,請先執行
composer cs-fix
進行代碼格式化; - 提交代碼前,請先執行
composer an
進行代碼靜態檢查; - 提交代碼前,請先執行
composer test
進行單元測試;單元測試不要在您的任何生產環境上運行,因為它會刪除添加數據; - 確保將 PR 創建為你的功能分支, 而不是 master 分支上直接提交修改。
- 如果你的 PR 修復了 bug,請提供有關相關 bug 的描述。