如何給 swoft 貢獻程式碼

Inhere發表於2019-10-15

有許多同學希望或已經在參與貢獻程式碼給swoft，這裡我們非常感謝大家的支援。但是仍然有一些同學不知道如何給我們貢獻程式碼或者貢獻程式碼時PR發錯位置，又或者格式不夠規範 :( 。

這裡我簡單介紹一下 如何給 swoft 貢獻程式碼。(其實主要的內容在swoft專案置頂的 issue 已經有說明)

操作流程

  • 請 fork 對應的 開發倉庫
  • 修改後，請把你的PR提交到對應的開發倉庫
  • 提交PR時，請寫明修復了什麼問題，改進什麼等資訊
  • 等待開發組人員審查程式碼
  • CI 測試通過，且程式碼審查通過後，我們會合並PR
  • 程式碼將會在下次版本中釋出

發起PR時的注意事項

我們非常歡迎各位同學提交PR(Pull Request)，但是為了保證程式碼質量和統一的風格，向官方的主倉庫 swoft/swoft 和 開發倉庫 貢獻程式碼時需要注意程式碼和commit格式

請不要提交PR到各個元件倉庫，它們都是 只讀的。 釋出版本時官方會將程式碼自動同步到各個子倉庫

Commit 提交規範

規範提交 commit資訊， 這樣 history 看起來更加清晰，還可以自動生成 changelog

  • commit message 只能是英文資訊
  • 請儘量保證commit message是有意義的說明
  • 最好以 add: update: fix: 等關鍵字開頭
  • 更多請參考 angular 規範

程式碼風格

  • 提交的PHP程式碼 必須 遵循 PSR-2 程式碼風格
  • 合理且有意義的類、方法、變數命名
  • 適當的註釋，合理的使用空行保持程式碼的簡潔，易於閱讀
  • 不要包含一些無意義的資訊 例如 @author 等(貢獻者是能夠從commit log或contributors裡看到的)
本作品採用《CC 協議》，轉載必須註明作者和本文連結

相關文章