Bring the issue templates up to the second generation - #292
Merged
Merged
Conversation
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why templates, and why
config.ymlmost of allconfig.ymlis 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
.sspjfiles attached to a public issue.SUPPORT.mdis read after the issue is open, so it cannot do this job.blank_issues_enabled: falsemeans the two forms and the contact links are thewhole set of front doors.
Which generation
Two generations of these templates exist in the family. This follows the newer
one (SSPlayerForUnity):
.sspjwarningSSConverterGUIandSpriteStudio-SDKstay on the older generation for now.Two links deliberately left out
SpriteStudio-SDKis private, so a link toits issues would 404 for exactly the people who would follow it. This follows
the reasoning already written into
SSPlayerForReactNative'sconfig.yml. Thebug 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.mdrather thana branch name — this repository's default branch is
develop, andHEADcannotgo 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.
SSConverterGUIandSpriteStudio-SDKstay on the first generation.What changes
.sspjwarning moves above the form. It was at the bottom, aftereverything had been typed — too late to stop an attachment.
rendering method (Forward+ / Mobile / Compatibility) and the affected component
become dropdowns; platforms become checkboxes instead of one free-text OS line.
SpriteStudioPlayer2D,SpriteStudioPartAttachment2D,SSABResource/SSQBResource,SpriteStudioAudioBackend, and the import pipeline.player, which is what separates this repository's bugs from the shared runtime's.
and where the change belongs.
Checks
All three files parse as YAML.