From 062c2054e3b94369c976ae7bd22bfa984b723340 Mon Sep 17 00:00:00 2001 From: Naruto TAKAHASHI Date: Thu, 27 Aug 2026 18:18:27 +0900 Subject: [PATCH] docs: bring the issue templates up to the second generation Two generations of these templates exist in the family, and this repository was on the first. It is also the only one of the ten that is public, so it is the only one whose templates anybody is actually filling in. What the newer generation changes: - The .sspj warning moves above the form. It was at the bottom, after everything had been typed, which is too late to stop an attachment. - Existing issues are linked from the header. - Environment fields become typed: the Godot version and plugin version stay inputs, the rendering method and the component become dropdowns, and the platforms become checkboxes rather than one free-text OS line. - The bug form asks whether the problem reproduces on another SpriteStudio player, which is what separates this repository's bugs from the shared runtime's. - config.yml gains the security policy and drops nothing. The shared core's issue tracker is still not linked: SpriteStudio-SDK is private, so it would 404 for the people who would follow it. The question in the bug form does that routing without a link. The SECURITY.md link uses blob/HEAD rather than a branch name, so it cannot go stale against a default branch that is develop here. --- .github/ISSUE_TEMPLATE/bug_report.yml | 117 +++++++++++++-------- .github/ISSUE_TEMPLATE/config.yml | 21 +++- .github/ISSUE_TEMPLATE/feature_request.yml | 44 +++++--- 3 files changed, 115 insertions(+), 67 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 6889108..383efea 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,81 +1,108 @@ -name: Bug Report / バグ報告 -description: Create a report to help us improve SSPlayerForGodot. / 不具合の報告 -title: "[Bug]: " +name: 🛠️ Bug report / 不具合の報告 +description: Something in the player behaves incorrectly. / プレイヤーの動作に問題がある場合。 labels: ["bug"] body: - type: markdown attributes: value: | - Thank you for reporting a bug! / 不具合の報告ありがとうございます！ - Please provide as much information as possible to help us investigate. / 調査をスムーズに行うため、可能な限り詳細な情報を提供してください。 + Thanks for taking the time to report this. + + Before filing, please [search existing issues](https://github.com/cri-middleware/SSPlayerForGodot/issues?q=is%3Aissue). + **Do not attach proprietary `.sspj` files here** — this is a public tracker. Use the + [Help Center](https://www.webtech.co.jp/help/en/spritestudio7/inquiries/ssplayer_tool/) to send those privately. + + 投稿前に既存の Issue を検索してください。**業務データの `.sspj` は公開の場である本 Issue に + 添付しないでください。** 送付が必要な場合はヘルプセンターをご利用ください。 - type: textarea - id: description + id: what-happened attributes: - label: Description / 不具合の内容 - description: A clear and concise description of what the bug is. / どのような不具合が発生しているか、簡潔に説明してください。 + label: What happened? / 症状 + description: What you expected, and what you got instead. / 期待した挙動と、実際の挙動。 validations: required: true - type: textarea - id: reproduction + id: repro attributes: - label: Steps to Reproduce / 再現手順 - description: Steps to reproduce the behavior. / 不具合を再現させるための手順を詳しく書いてください。 + label: Steps to reproduce / 再現手順 + description: | + The smallest sequence that shows the problem. A minimal `.ssab` helps a lot. + 問題を再現できる最小限の手順。最小限の `.ssab` があると助かります。 placeholder: | - 1. Open '...' - 2. Run '...' - 3. See error + 1. Add a SpriteStudioPlayer2D to a scene + 2. Assign the .ssab resource + 3. Play "..." + 4. See ... validations: required: true - - type: textarea - id: expected_behavior + - type: input + id: player-version attributes: - label: Expected Behavior / 期待される動作 - description: A clear and concise description of what you expected to happen. / 本来どのような動作を期待していたか説明してください。 + label: Plugin version / プラグインのバージョン + description: The release you installed, or the commit you are on. + placeholder: 7.0.0-beta.1 validations: required: true - type: input - id: godot_version + id: godot-version attributes: - label: Godot Version / Godotのバージョン - description: What version of Godot are you using? / ご利用のGodotのバージョンを記載してください。 - placeholder: e.g. 4.7.0-stable + label: Godot version / Godot のバージョン + placeholder: 4.7.0-stable validations: required: true - - type: input - id: plugin_version + - type: dropdown + id: renderer attributes: - label: Plugin Version / プラグインのバージョン - description: What version of this plugin are you using? (e.g., v1.0.0 or commit hash). / 利用している本プラグインのバージョンタグ（v1.0.0等）、またはコミットハッシュ。 + label: Rendering method / レンダリング方式 + options: + - Forward+ + - Mobile + - Compatibility + - Not sure / わからない validations: required: true - - type: input - id: environment + - type: dropdown + id: component attributes: - label: Operating System / OS - description: What OS are you developing on? / 開発を行っているOS。 - placeholder: e.g. Windows 11 / macOS 14 / Ubuntu 22.04 - validations: - required: true + label: Which component? / どの機能か + options: + - SpriteStudioPlayer2D (playback) + - SpriteStudioPartAttachment2D (attaching nodes to parts) + - SSABResource / SSQBResource (loading) + - SpriteStudioAudioBackend (audio) + - Import pipeline (.sspj → .ssab) + - Other / わからない・その他 + + - type: checkboxes + id: platforms + attributes: + label: Platforms affected / 発生するプラットフォーム + options: + - label: Editor (macOS) + - label: Editor (Windows) + - label: Editor (Linux) + - label: Exported desktop build + - label: Android + - label: iOS + - label: Web - type: textarea - id: additional_context + id: logs attributes: - label: Additional Context & Error Logs / 補足情報・エラーログ - description: Add any other context or paste relevant error messages from the Godot output console here. / その他、不具合に関する補足情報や、Godotのコンソールに出力されたエラーメッセージを記載してください。 + label: Godot output / 出力コンソール + description: Any errors, warnings, or stack traces. / エラー・警告・スタックトレース。 + render: text - - type: markdown + - type: textarea + id: other-players attributes: - value: | - --- - **🚨 WARNING / 警告 🚨** - **DO NOT** attach proprietary `.sspj` project files or sensitive data to this public issue. - If you need to share reproduction data, please submit it privately via the [Help Center](https://www.webtech.co.jp/help/ja/spritestudio7/inquiries/ssplayer_tool/). - - **絶対に** 機密情報や非公開の `.sspj` プロジェクトデータをここに添付しないでください。 - 再現データの提供が必要な場合は、[公式ヘルプセンター](https://www.webtech.co.jp/help/ja/spritestudio7/inquiries/ssplayer_tool/)から非公開で送信してください。 + label: Does it reproduce on another SpriteStudio player? / 他の SpriteStudio Player でも再現しますか？ + description: | + If it does, the cause is most likely the shared SpriteStudio runtime rather than this + player, and saying so here saves a round trip. + 再現する場合は、この Player 固有ではなく共通ランタイム側の可能性が高いため、その旨をお書きください。 diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index b23c945..5e87604 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,8 +1,19 @@ +# Issues are for bugs and feature requests. Everything else has a better home — +# see SUPPORT.md, which these links mirror. +# +# One link the sibling players carry is deliberately absent: the shared +# SpriteStudio core's issue tracker. SpriteStudio-SDK is not public, so it +# would 404 for exactly the people who would follow it. blank_issues_enabled: false contact_links: - - name: 💬 SpriteStudio Community / コミュニティ (使い方や質問) + - name: ❓ Question about how to use the player / 使い方の質問 url: https://spritestudio.jp/community/ - about: Please ask general questions about how to use the SDK here. / SDKの使い方などの一般的なご質問はこちらのコミュニティをご利用ください。 - - name: 🔒 Private Inquiries & Data Submission / 非公開でのご相談・データ送付 - url: https://www.webtech.co.jp/help/ja/spritestudio7/inquiries/ssplayer_tool/ - about: Use this for private inquiries or when sending sensitive reproduction data. / 非公開での相談や、再現データの送付が必要な場合は公式ヘルプセンターをご利用ください。 + about: Implementation advice and tips, in the official community forum. Issues are not for usage questions. + + - name: 🔒 Private inquiry, or sending reproduction data / 個別のお問い合わせ・データ送付 + url: https://www.webtech.co.jp/help/en/spritestudio7/inquiries/ssplayer_tool/ + about: Use the Help Center for sensitive reports, proprietary .sspj files, or contractual support. Never attach proprietary data to a public issue. + + - name: 🛡️ Security vulnerability / 脆弱性の報告 + url: https://github.com/cri-middleware/SSPlayerForGodot/blob/HEAD/SECURITY.md + about: Do not open a public issue. See the security policy for how to report privately. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 614184c..bce6b9d 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -1,39 +1,49 @@ -name: Feature Request / 機能要望 -description: Suggest an idea for this project. / 新機能や改善のアイデアを提案する -title: "[Feature]: " +name: ✨ Feature request / 要望 +description: Suggest a new capability or an improvement. / 新機能や改善のご提案。 labels: ["enhancement"] body: - type: markdown attributes: value: | - Thank you for suggesting a feature! / 機能のご提案ありがとうございます！ + Please check [ROADMAP.md](https://github.com/cri-middleware/SSPlayerForGodot/blob/develop/ROADMAP.md) + first — it lists what is planned, and which items are waiting on the shared SpriteStudio SDK. + + まず [ROADMAP.md](https://github.com/cri-middleware/SSPlayerForGodot/blob/develop/ROADMAP.md) を + ご確認ください。予定済みの項目と、共通 SDK 側の対応待ちの項目が記載されています。 - type: textarea id: problem attributes: - label: Is your feature request related to a problem? / その要望は、何か困っていることに関連していますか？ - description: A clear and concise description of what the problem is. / どのような課題や不便さがあるか、詳しく説明してください。 - placeholder: | - I'm always frustrated when [...] + label: What problem does this solve? / 解決したい課題 + description: | + Describe the situation you are stuck in, not just the feature you have in mind — it often + leads to a better answer. + ご要望の機能そのものより、お困りの状況をお書きください。より良い解決策が見つかることがあります。 validations: required: true - type: textarea - id: solution + id: proposal attributes: - label: Describe the solution you'd like / 実現したい解決策 - description: A clear and concise description of what you want to happen. / どのような機能や動作を期待しているか説明してください。 + label: What would you like it to do? / ご提案の内容 validations: required: true - type: textarea id: alternatives attributes: - label: Describe alternatives you've considered / 他に検討した代替案 - description: A clear and concise description of any alternative solutions or features you've considered. / 他に検討した解決策があれば記載してください。 + label: What are you doing today instead? / 現在の回避方法 + description: Workarounds you have tried, and why they fall short. / 試した回避策と、不十分な点。 - - type: textarea - id: additional_context + - type: dropdown + id: scope attributes: - label: Additional Context / 補足情報 - description: Add any other context or screenshots about the feature request here. / その他、機能に関する補足情報やスクリーンショットがあれば記載してください。 + label: Where does this belong? / 対象範囲 + description: | + Playback behaviour is usually the shared SpriteStudio runtime; this repository owns + the nodes, the GDExtension and the import pipeline. Unsure is fine. + 再生の挙動は共通ランタイム側です。わからない場合はそのままで構いません。 + options: + - Godot side (nodes, GDExtension, import pipeline) + - Shared SpriteStudio runtime (playback behaviour) + - Not sure / わからない