iT邦幫忙

2024 iThome 鐵人賽

DAY 9
1
IT 管理

30天從版控到code review的實踐指南系列 第 9

Day 9. Git 操作入門:什麼是 Issue Tracking?

  • 分享至 

  • xImage
  •  

什麼是 Issue Tracking?


Issue Tracking 是一種專案管理方法,用來記錄、追蹤和管理程式開發過程中的 bug、功能需求、技術債、功能擴充建議或其他待辦事項。可透過專門的工具(如 GitHub Issues、Trello Boards、Notion Templates 等)輔助實作,目的是確保所有開發團隊成員對問題的狀態、優先順序和解決方案資訊同步。

Issue Tracking 功能與優點


  1. 問題說明
    • 由開發人員、系統使用者、其他團隊成員等發現問題者,提出問題,並提供問題詳細描述,包含重現步驟、系統環境等資訊。
    • 優點:開發人員易於重現問題,加快問題解決速度。
  2. 優先處理順序與處理狀態
    • 對每個 Issue 設定處理級別以及處理狀態,如待處理、進行中、已解決。
    • 優點:有效資源分配,利於工作進度排程。
  3. 任務分配
    • 分配 Issue 給特定開發人員或團隊,讓大家知道誰負責解決這個問題。
    • 優點:責任分配明確,促進團隊合作。
  4. 溝通協作
    • 團隊成員可以在 Issue 中討論解決方案,並在工作進行時更新狀態。
    • 優點:即時反饋,知識共享。
  5. 歷史追蹤
    • 紀錄每個問題的變更歷程,方便後續回顧問題解決的過程。
    • 優點:易於問題回顧,提升團隊問責性。

GitHub Issues 實作 Issue Tracking


  1. .githubISSUE_TEMPLATE 資料夾 — 名字需相同

  2. 加入 config.yml — 名字需相同

    設定為 false:user 只能根據預設的 Issue Templates 加入 Issues,無法自行加入沒有模板的空白 Issue。確保每個 Issue 有問題或需求的完整資訊。

    blank_issues_enabled: false
    
  3. 加入 fix.yml

    name: Bug 回報
    description: 提交一個錯誤 / 問題
    title: "[BUG] 標題"
    labels: ["type: bug(fix)"]
    body:
    - type: checkboxes
      attributes:
        label: 是否已存在相關的Issues,且尚待解決中。(必填)
        description: 請搜尋看是否已有類似的錯誤問題。
        options:
        - label: 已搜尋過現有Issues。
          required: true
    - type: input
      attributes:
        label: 發生時間(必填)
        description: 格式 YYYY-MM-DD HH:MM
      validations:
        required: true
    - type: textarea
      attributes:
        label: 重現問題步驟(必填)
        description: 簡單描述做了什麼事情
        render: markdown
      validations:
        required: true
    - type: textarea
      attributes:
        label: 預期行為
        description: 簡單描述原本預期會發生什麼事情
        render: markdown
      validations:
    - type: textarea
      attributes:
        label: 平台環境
        description: |
          例:
            - **作業系統**: Win 10
            - **瀏覽器**: Chrome
            - **瀏覽器版本**: 13.14.0
        value: |
            - 作業系統:
            - 瀏覽器:
            - 瀏覽器版本:
        render: markdown
      validations:
        required: false
    - type: input
      attributes:
        label: error messages
      validations:
        required: false
    - type: textarea
      attributes:
        label: 其他補充
        description: |
          點擊此區域加入補充資訊:連結、截圖或影片。
      validations:
        required: false
    
  4. GitHub 畫面

https://ithelp.ithome.com.tw/upload/images/20240923/20169483efvWnbEPO1.png

Reference



上一篇
Day 8. Git 操作入門:建立 PR 範本;程式碼合併 conflicts 如何解決?
下一篇
Day 10. Git 操作入門:如何加標籤 Tag?
系列文
30天從版控到code review的實踐指南30
圖片
  直播研討會
圖片
{{ item.channelVendor }} {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

尚未有邦友留言

立即登入留言