Issue の報告

Tuist のユーザーとして、バグや予期しない動作に遭遇することがあるかもしれません。 その場合は、ぜひ報告してください。私たちが修正に取り組みます。

GitHub Issues は当プロジェクトのチケット管理プラットフォームです

問題は GitHub の Issue として報告し、Slack など他のプラットフォームでは報告しないでください。 GitHub は、問題の追跡や管理に適しており、コードベースに近い場所で問題の進捗を追うことができます。 加えて、問題の詳細な説明が推奨されるため、報告者は問題について考え、より多くの背景情報を提供することが求められます。

背景情報が鍵

背景情報が不十分な課題は不完全と見なされ、作成者は追加の情報を要求されます。 もし背景情報が提供されない場合、 Issue はクローズされます。 逆に言えば、コンテキストを多く提供するほど、私たちが問題を理解し、解決するのが容易になります。 そのため、Issue を解決してほしい場合は、できるだけ詳しい情報を提供してください。 次の質問に答える形で情報を記載してください。

• 試したことは何か？
• プロジェクトの依存関係の状態はどうなっているのか？
• 使用している Tuist のバージョンは？
• その問題はあなたの作業をブロックしているのか？

また、最小限の再現可能なプロジェクトの提供もお願いしています。

再現可能なプロジェクト

再現可能なプロジェクトとは？

再現可能なプロジェクトは、問題を実証するための小さなTuistプロジェクトです - 多くの場合、この問題はTuistのバグによって引き起こされます。 再現可能なプロジェクトには、バグを明確に示すために必要な最小限の機能が含まれている必要があります。

なぜ再現可能なテストケースを作成する必要がありますか？

再現性のあるプロジェクトでは、問題の原因を特定することができます。これは、問題を解決するための最初のステップです！ バグレポートの最も重要な部分は、バグを再現するために必要な正確なステップを記述することです。

再現可能なプロジェクトは、バグを引き起こす特定の環境を共有するのに最適な方法です。 あなたの再現可能なプロジェクトは、あなたを助けたい人々を助けるための最善の方法です。

再現可能なプロジェクトを作成する手順

• 新しい git リポジトリを作成します。
• リポジトリのディレクトリで tuist init を使用してプロジェクトを初期化します。
• あなたが見たエラーを再現するために必要なコードを追加してください。
• コードを公開(GitHubアカウントはこれを行うのに適した場所です)して、Issue を作成する際にリンクを掲載してください。

再現可能なプロジェクトの利点

• 最小限の範囲: エラー部分以外をすべて取り除くことで、どこにバグがあるのかを探るために余計な部分を深く調べる必要がなくなります。
• 秘密のコードを公開する必要はありません: メインサイトを公開できない場合があります (多くの理由で)。 再現可能なテストケースとしてその小さな部分を再現することで、秘密のコードを公開せずに問題を公開することができます。
• バグの証拠： 時々バグはあなたのマシンの設定を組み合わせることによって引き起こされます。 再現可能なテストケースは、コントリビューターがあなたのビルドをダウンロードして彼らのマシンでテストすることを可能にします。 これは問題の原因を検証し、絞り込むのに役立ちます。
• バグ修正のサポートを得る: 他の人があなたの問題を再現できる場合、彼らが問題を解決する可能性は高いです。 バグを修正するためには、まずそれを再現できなければほとんど不可能です。