Skip to content

Bring the issue templates up to the second generation - #292

Merged
Naruto merged 1 commit into
developfrom
docs/issue-templates-second-generation
Aug 27, 2026
Merged

Naruto merged 1 commit into
developfrom
docs/issue-templates-second-generation

Conversation

@Naruto

@Naruto Naruto commented Aug 27, 2026

Copy link
Copy Markdown
Collaborator

Why templates, and why config.yml most of all

config.yml is the only thing that routes a reader before they open an issue.
Without it a public tracker collects how-to questions, and — the part that
actually costs something — proprietary .sspj files attached to a public issue.
SUPPORT.md is read after the issue is open, so it cannot do this job.

blank_issues_enabled: false means the two forms and the contact links are the
whole set of front doors.

Which generation

Two generations of these templates exist in the family. This follows the newer
one (SSPlayerForUnity):

older (SSConverterGUI, SpriteStudio-SDK) newer (here)
.sspj warning at the bottom, after the form at the top, before anything is typed
search existing issues linked in the header
contact links community, Help Center plus routing for the shared runtime
environment fields free text typed inputs, dropdowns, checkboxes

SSConverterGUI and SpriteStudio-SDK stay on the older generation for now.

Two links deliberately left out

  • The shared core's issue tracker. SpriteStudio-SDK is private, so a link to
    its issues would 404 for exactly the people who would follow it. This follows
    the reasoning already written into SSPlayerForReactNative's config.yml. The
    bug form still asks whether the problem reproduces on another SpriteStudio
    player — the question is what routes it, and it needs no link.

The security link is new here, and points at blob/HEAD/SECURITY.md rather than
a branch name — this repository's default branch is develop, and HEAD cannot
go stale against it.

Why this repository

It is the only one of the ten that is already public, so it is the only one
whose issue templates anybody is actually filling in. SSConverterGUI and
SpriteStudio-SDK stay on the first generation.

What changes

  • The .sspj warning moves above the form. It was at the bottom, after
    everything had been typed — too late to stop an attachment.
  • Existing issues are linked from the header.
  • Environment fields become typed. Godot version and plugin version stay inputs;
    rendering method (Forward+ / Mobile / Compatibility) and the affected component
    become dropdowns; platforms become checkboxes instead of one free-text OS line.
  • The component dropdown names the real classes — SpriteStudioPlayer2D,
    SpriteStudioPartAttachment2D, SSABResource / SSQBResource,
    SpriteStudioAudioBackend, and the import pipeline.
  • 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.
  • The feature form asks what problem the request solves before what it should do,
    and where the change belongs.

Checks

All three files parse as YAML.

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.
@Naruto
Naruto merged commit 73c94a8 into develop Aug 27, 2026
0 of 2 checks passed
@Naruto
Naruto deleted the docs/issue-templates-second-generation branch September 13, 2026 13:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant