github.com/Ptt-official-app/go-bbs@v0.12.0/FOR_DEVELOPERS.md (about)

     1  # 給開發者的資訊
     2  
     3  ## 1. 開發環境建置
     4  
     5  安裝下列的應用程式來建構開發環境：
     6  
     7  | 應用程式名稱 | 應用程式版本(有特定版本才填寫) | 安裝要求 |
     8  | ------- | ------- | ------- |
     9  |[Golang](https://golang.org/dl/)|1.14 以上|必要|
    10  |[GoLand](https://www.jetbrains.com/go/promo/)| |如果使用 GoLand * 推薦給新手|
    11  |[Sublime Text 3](https://classic.yarnpkg.com/zh-Hant/)| |如果使用 Sublime Text，記得安裝 Gofmt 套件|
    12  |[docker compose](https://docs.docker.com/compose/install/)| |使用 `docker compose` 直襲本專案時|
    13  
    14  ### 1-1. Sublime Text 3 的套件
    15  
    16  要使用 Sublime Text 3，請安裝以下套件。
    17  
    18  | 套件 | 安裝要求 |
    19  | ------- | ------- |
    20  |[Gofmt](https://packagecontrol.io/packages/Gofmt)|可選|
    21  |[ConvertToUTF8](https://ephrain.net/sublime-text-%E8%AE%93-sublime-text-%E6%94%AF%E6%8F%B4-big5-%E7%B7%A8%E7%A2%BC%E7%9A%84%E6%96%87%E5%AD%97%E6%AA%94/)|可選|
    22  
    23  ---
    24  
    25  ## 2. 下載測試伺服器靜態資料
    26  
    27  ```bash
    28  # 下載 BBS Home
    29  $ wget http://pttapp.cc/data-archives/bbs_backup_lastest.tar.xz
    30  # 用 xz 進行解壓縮
    31  $ tar -Jxvf bbs_backup_lastest.tar.xz
    32  
    33  # 下載 SHM 測試資料
    34  $ wget http://pttapp.cc/data-archives/dump.shm.lastest.tar.bz2
    35  # 用 bzip2 進行解壓縮
    36  $ tar -jxvf dump.shm.lastest.tar.bz2
    37  ```
    38  
    39  
    40  ## 3. 測試此專案
    41  
    42  請在工作目錄(./go-bbs)下執行此命令。
    43  
    44  ### 3-1. 直接使用 `go test` 的狀況
    45  
    46  #### 3-1-1. 安裝以及編譯
    47  
    48  ```bash
    49  # 編譯
    50  $ go test
    51  ```
    52  
    53  ---
    54  
    55  ## 4. 生產環境/其他環境的判定
    56  
    57  // TODO
    58  
    59  ---
    60  
    61  ## 5. 分支規則
    62  
    63  只允許推送 Pull Request 到 `development` 。
    64  在推送 Pull Request 時，請依照以下命名規則為您的分支命名
    65  
    66  | 變更種類 | 分支的命名規則 |
    67  | ---- | ---- |
    68  |新增功能|`feature/#{ISSUE_ID}-#{branch_title_name}`|
    69  |Hotfix commit|`hotfix/#{ISSUE_ID}-#{branch_title_name}`|
    70  
    71  ### 5-1. 基本分支
    72  
    73  
    74  | 目的 | 分支 | 誰可以發 Pull Request | 備註 |
    75  | ---- | ---- | ---- | ---- |
    76  | 開發 | development | All developers | 基本上請推送 Pull Request 到這裡 |
    77  | 正式版 | master | Only administrators | 禁止管理員以外的人推送 Pull Request |
    78