貢獻指南
Goravel 歡迎來自不同才能的豐富多樣的貢獻,如編程、翻譯、文章、教程等. 在完成兩個功能(5 個 Good First Issue
= 1 個 Feature
)後,你將被認可為核心貢獻者. 每三個月完成一個功能,你可以保持此身份.
讓我們一起讓 Goravel 更高效!
獎勵
- 核心開發者在 Goravel 未來獲益時將有資格獲得福利.
- 完成一個
Feature
後,你將獲得一件官方的 Goravel T-Shirt,每個主要版本發行週期最多獲得 1 件. (PS: 由於國家的差異,你可能需要幫助我們找到合適的供應商.)
核心開發者
貢獻者
Bug 反饋
你可以在 這裡 提交一個 Bug 反饋,請在提交前搜索 問題列表 是否存在類似問題. 報告應包含一個標題和清晰的問題描述,並提供盡可能多的相關信息以及演示該問題的代碼範例. Bug 反饋的目標是使你自己以及其他人能夠輕鬆地復現 Bug 並開發修復. Goravel 鼓勵提交者在同時創建 PR 以修復 Bug,使開源項目得到更積極的發展.
支持問題
Goravel 的 GitHub 問題追踪器不旨在提供 Goravel 的幫助或支持. 相反,請使用以下渠道之一:
開發討論
你可以在 Goravel 框架庫的 GitHub 討論區 提出新功能或改進現有 Goravel 行為. 有關錯誤、新功能和現有功能實施的非正式討論在 Discord 或微信群進行. Goravel 的維護者 Bowen 通常在工作日的早上 9 點到晚上 6 點(UTC+08:00)出現在群組中,其他時間偶爾會出現.
新增語言
歡迎為 Goravel 文檔添加新語言,可以提交一個標題為 "Add [Language] Language" 的 Issue 並附上你的 Crowdin 帳號到 goravel/goravel. 將邀請你進入 Crowdin 項目.
貢獻
尋找/創建 Issue
你可以在 問題列表 中找到或創建一個問題,留言表達你想處理該問題的意願,並在得到庫維護者確認後開始處理.
創建 PR
- 如果你是該流程的新手,可以查看 這篇文章 ;
- 在開發過程中,如果遇到問題,可以隨時在問題中詳細描述該問題以便進一步溝通,但在此之前,請確保你已盡可能通過 Google 等方法嘗試解決問題.
- 在創建 PR 前,請盡可能提高單元測試的覆蓋率,以提供更穩定的功能.
- 如果修改了
contracts
文件夾下的任何文件,請在根目錄下運行go run github.com/vektra/mockery/v2
命令來生成 mock 文件. - 當 PR 開發完成後,請為其添加
Review Ready
標籤,維護者會及時進行審核. - 在 PR 合併後,如果 PR 中的描述設置正確,問題將被自動關閉.
- Goravel 非常感謝你的貢獻,並將在下次發佈時把你添加到首頁貢獻列表中; ❤️
哪個分支?
所有錯誤修復應發送到最新的穩定分支,除非它們修復了僅存在於即將到來的發佈中的功能.
新功能或具有破壞性變化的功能應始終合併到 master
分支.
Goravel 倉庫
倉庫 | 操作 |
---|---|
goravel/goravel | Goravel 脚手架 |
goravel/framework | Goravel 主倉庫 |
goravel/example | Goravel 示例 |
goravel/example-client | Grpc 客戶端示例 |
goravel/example-proto | example 仓库 proto 依赖 |
goravel/example-package | 扩展包示例 |
goravel/docs | 使用文檔 |
goravel/docs-web | Goravel 官网 |
goravel/s3 | Storage 模块 S3 驱动 |
goravel/oss | Storage 模块 OSS 驱动 |
goravel/cos | Storage 模块 COS 驱动 |
goravel/minio | Storage 模块 Minio 驱动 |
goravel/cloudinary | Storage 模組的 Cloudinary 驅動 |
goravel/redis | 緩存模組的 Redis 驅動 |
goravel/gin | 路由模組的 Gin 驅動 |
goravel/fiber | 路由模組的 Fiber 驅動 |
goravel/postgres | 資料庫模組的 Postgres 驅動 |
goravel/mysql | 資料庫模組的 MySQL 驅動 |
goravel/sqlserver | 資料庫模組的 SQLServer 驅動 |
goravel/sqlite | 資料庫模組的 SQLite 驅動 |
goravel/file-rotatelogs | 為 Log 模組提供日誌分割功能 |
goravel/.github | 社區健康文件 |
行為準則
Goravel 的行為準則源自 Laravel 的行為準則。 任何違反行為準則的行為都可以向 Bowen 報告。
- 參與者必須容忍不同的觀點。
- 參與者必須確保他們的語言和行為不包含人身攻擊和貶低言論。
- 在解讀他人的言語和行為時,參與者應始終假設良好的意圖。
- 可合理視為騷擾的行為將不被容忍。