問題レポート ガイドライン

効果的なバグ レポートと機能リクエストは XOOPS 開発に重要です。このガイドは高品質な問題を作成するのに役立ちます。

---

レポート前に

既存の問題をチェック

常に最初に検索:

1. GitHub Issues に進む
2. 問題に関連するキーワードを検索
3. クローズされた問題を確認 - 既に解決されている可能性
4. プルリクエストを確認 - 進行中の可能性

検索フィルターを使用:

• is:issue is:open label:bug - 未解決のバグ
• is:issue is:open label:feature - 未解決の機能リクエスト
• is:issue sort:updated - 最近更新された問題

本当に問題ですか

まず検討:

• 設定の問題? - ドキュメントを確認
• 使用方法の質問? - フォーラムまたは Discord コミュニティで質問
• セキュリティ問題? - #security-issues セクションを参照
• モジュール固有? - モジュール メンテナーにレポート
• テーマ固有? - テーマ作成者にレポート

---

問題タイプ

バグ レポート

バグは予期しない動作または欠陥です。

例:

• ログインが機能しない
• データベース エラー
• フォーム検証がない
• セキュリティ脆弱性

機能リクエスト

機能リクエストは新しい機能の提案です。

例:

• 新しい機能のサポートを追加
• 既存機能を改善
• 不足しているドキュメントを追加
• パフォーマンスを改善

拡張

拡張は既存機能を改善します。

例:

• より良いエラー メッセージ
• パフォーマンスの向上
• より良い API デザイン
• より良いユーザー エクスペリエンス

ドキュメント

ドキュメント問題は、不完全またはインコレクト ドキュメントを含みます。

例:

• 不完全な API ドキュメント
• 古いガイド
• 不足しているコード例
• ドキュメント内の誤字

---

バグをレポート

バグ レポート テンプレート

## 説明
バグの簡潔で明確な説明。

## 再現ステップ
1. ステップ 1
2. ステップ 2
3. ステップ 3

## 期待される動作
何が起こるべきか。

## 実際の動作
実際に起こること。

## 環境
- XOOPS バージョン: X.Y.Z
- PHP バージョン: 8.2/8.3/8.4
- データベース: MySQL/MariaDB バージョン
- オペレーティング システム: Windows/macOS/Linux
- ブラウザー: Chrome/Firefox/Safari

## スクリーンショット
該当する場合、問題を示すスクリーンショットを追加。

## 追加のコンテキスト
その他の関連情報。

## 可能な修正
問題の修正に関する提案がある場合 (オプション)。

---

セキュリティ問題

パブリックにレポートしないこと

セキュリティ脆弱性のためにパブリック問題を作成しないこと。

プライベートにレポート

1. セキュリティ チームにメール: security@xoops.org
2. 含める:
   • 脆弱性の説明
   • 再現ステップ
   • 潜在的な影響
   • 連絡先情報

責任ある開示

• 48 時間以内に受信を確認
• 7 日ごとに更新を提供
• 修正タイムラインに取り組む
• ディスカバリーのクレジットをリクエスト可能
• パブリック開示のタイミングを調整

---

問題タイトル ベストプラクティス

良いタイトル

✅ ログイン ページはデータベース接続が失敗した場合に空白のエラーを表示
✅ 二要素認証サポートを追加
✅ フォーム検証がコメント フィールドで SQL インジェクションを防止していない
✅ ユーザー リスト クエリのパフォーマンスを改善
✅ PHP 8.2 向けインストール ドキュメントを更新

悪いタイトル

❌ システムのバグ
❌ 助けて!!
❌ 機能しない
❌ XOOPS に関する質問
❌ エラー

---

問題の説明 ベストプラクティス

重要な情報を含める

1. 何 - 問題の明確な説明
2. どこ - ページ、モジュール、または機能
3. いつ - 再現ステップ
4. 環境 - バージョン、OS、ブラウザー、PHP
5. なぜ - これが重要な理由

ラベルを使用

以下を分類するラベルを追加:

• bug - バグ レポート
• enhancement - 拡張リクエスト
• documentation - ドキュメント問題
• help wanted - 助けを求めている
• good first issue - 新しいコントリビューター向け

---

レポート後

反応性を保つ

• 問題コメントで質問をチェック
• リクエストされた場合、追加情報を提供
• 提案された修正をテスト
• 新しいバージョンでバグが存在するか確認

エチケットに従う

• 尊重とプロフェッショナルである
• 良い意図を仮定
• 修正を要求しない - 開発者はボランティア
• 可能な場合は支援を申し出る
• コントリビューターに感謝を表す

問題を焦点を当てる

• トピックに留まる
• 無関連な問題を議論しない
• 関連する問題へのリンク代わり
• 機能投票に問題を使用しない

---

関連ドキュメント

• 行動規範
• 貢献ワークフロー
• プルリクエスト ガイドライン
• 貢献概要

---

#xoops #issues #bug-reporting #feature-requests #github