# 問題回報 {#issue-reporting}

作為 Tuist 用戶，你可能會遇到錯誤或預期外的行為。如果發生這種情況，我們鼓勵你回報問題，以便我們修復。

## GitHub Issues 是我哋嘅問題追蹤平台 {#github-issues-is-our-ticketing-platform}

問題應該喺 GitHub 上以 [GitHub issues](https://github.com/tuist/tuist/issues) 形式回報，而唔係喺 Slack 或其他平台。GitHub 更適合追蹤同管理問題、更接近代碼庫，亦令我哋可以追蹤問題進度。此外，佢鼓勵詳細描述問題，迫使回報者思考問題並提供更多背景資訊。

## 背景資訊至關重要 {#context-is-crucial}

缺乏足夠背景資訊嘅問題會被視為不完整，作者將被要求提供額外背景資訊。如果無提供，問題將會被關閉。你可以咁樣諗：你提供越多背景資訊，我哋就越容易理解問題並修復佢。所以如果你希望問題得到修復，請盡可能提供最多背景資訊。嘗試回答以下問題：

- 你當時想做乜？
- 你嘅依賴圖係點樣？
- 你使用緊邊個版本嘅 Tuist？
- 呢個問題會阻礙你嗎？

我哋亦要求你提供一個最小化嘅 **可重現項目**。

## 可重現項目 {#reproducible-project}

### 乜嘢係可重現項目？ {#what-is-a-reproducible-project}

可重現項目係一個小型 Tuist 項目，用於示範問題——通常呢個問題係由 Tuist 中嘅錯誤引起。你嘅可重現項目應該只包含清晰示範錯誤所需嘅最少功能。

### 點解你要建立可重現測試案例？ {#why-should-you-create-a-reproducible-test-case}

可重現項目令我哋可以隔離問題成因，這係修復問題嘅第一步！任何錯誤報告中最重要嘅部分係描述重現錯誤所需嘅確切步驟。

可重現項目係分享導致錯誤嘅特定環境嘅好方法。你嘅可重現項目係幫助想幫你嘅人嘅最佳方式。

### 建立可重現項目嘅步驟 {#steps-to-create-a-reproducible-project}

- 建立一個新嘅 git 儲存庫。
- 喺儲存庫目錄中使用 `tuist init` 初始化項目。
- 添加重現你所見錯誤所需嘅代碼。
- 發布代碼（你嘅 GitHub 帳戶係一个好地方），然後喺建立問題時連結到佢。

### 可重現項目嘅好處 {#benefits-of-reproducible-projects}

- **範圍更小：** 通過移除除錯誤之外嘅所有內容，你無需費力尋找錯誤。
- **無需發布機密代碼：** 你可能無法發布你嘅主要項目（出於多種原因）。將其一小部分重新製作成可重現測試案例，讓你可以在不暴露任何機密代碼嘅情況下公開示範問題。
- **錯誤證明：** 有時錯誤係由你機器上某些設定組合引起。可重現測試案例允許貢獻者下載你嘅構建並喺佢哋嘅機器上測試。這有助於驗證並縮小問題成因。
- **獲得修復錯誤嘅幫助：** 如果其他人可以重現你嘅問題，佢哋通常有好大機會修復問題。如果無法首先重現錯誤，幾乎不可能修復佢。
