FOR_DEVELOPERS.md

給開發者的資訊

1. 開發環境建置

安裝下列的應用程式來建構開發環境：

應用程式名稱	應用程式版本(有特定版本才填寫)	安裝要求
Golang	1.14 以上	必要
GoLand		如果使用 GoLand * 推薦給新手
Sublime Text 3		如果使用 Sublime Text，記得安裝 Gofmt 套件
docker compose		使用 docker compose 直襲本專案時

1-1. Sublime Text 3 的套件

要使用 Sublime Text 3，請安裝以下套件。

套件	安裝要求
Gofmt	可選
ConvertToUTF8	可選

---

2. 下載測試伺服器靜態資料

# 下載 BBS Home
$ wget http://pttapp.cc/data-archives/bbs_backup_lastest.tar.xz
# 用 xz 進行解壓縮
$ tar -Jxvf bbs_backup_lastest.tar.xz

# 下載 SHM 測試資料
$ wget http://pttapp.cc/data-archives/dump.shm.lastest.tar.bz2
# 用 bzip2 進行解壓縮
$ tar -jxvf dump.shm.lastest.tar.bz2

3. 測試此專案

請在工作目錄(./go-bbs)下執行此命令。

3-1. 直接使用 go test 的狀況

3-1-1. 安裝以及編譯

# 編譯
$ go test

---

4. 生產環境/其他環境的判定

// TODO

---

5. 分支規則

只允許推送 Pull Request 到 development 。 在推送 Pull Request 時，請依照以下命名規則為您的分支命名

變更種類	分支的命名規則
新增功能	feature/#{ISSUE_ID}-#{branch_title_name}
Hotfix commit	hotfix/#{ISSUE_ID}-#{branch_title_name}

5-1. 基本分支

目的	分支	誰可以發 Pull Request	備註
開發	development	All developers	基本上請推送 Pull Request 到這裡
正式版	master	Only administrators	禁止管理員以外的人推送 Pull Request