chore: issue templates written for the people who play - #15
Merged
Merged
Conversation
The repository had none, so an issue arrived as a blank box. The SDK's templates are no model here: they ask for a package manager command, and a GM who installed through Foundry's own installer has no terminal. Every field below can be answered from inside Foundry, and each one says where to look. Three templates and a config: - **Something is broken.** Module version, Foundry version, game system, what happened, how to make it happen again, and the console's red lines. - **An import left something out.** The one the SDK has no counterpart for, and where most reports will land. Most skips are on purpose, so it lists the three documented reasons first and asks for the report's skipped lines verbatim. It asks for a setting's kind of value, never the value, and says not to attach the profile file: that file can hold a password when the box for those was ticked. - **An idea.** - The config turns blank issues off and points two kinds of report elsewhere: an update row saying "no published release" is about the other module's repository, and a Foundry problem goes to Foundry. Labels are the ones this repository already has. The SDK's templates also add `triage`, which does not exist here and would be ignored without a word. The README links the chooser under the opening lines.
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
1 participant
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.
The repository had no issue templates, so a report arrived as a blank box. With the module past 800 downloads, the first ones are coming.
Why not copy the SDK's
They ask for
bun pm ls | grep @vttforge/core. A GM who installed through Foundry's own installer has no terminal and no lockfile. Every field here can be answered from inside Foundry, and each one says where to look: the module version on Add-on Modules, the Foundry version at the bottom of the setup screen, errors from F12 → Console.The templates
Something is broken. Module version, Foundry version, game system (free text — any system, and it is the likeliest thing to interact), what happened, how to make it happen again, and the console's red lines.
An import left something out. The SDK has no counterpart, and this is where most reports will land. Most skips are on purpose, so the template lists the three documented reasons first — the owning module is not installed, the setting changed scope, user settings land on whoever imports — and asks for the report's skipped lines verbatim, since that report already names the reason. It asks for a setting's kind of value, never the value, and says plainly not to attach the profile file: that file can hold a password when the box for those was ticked.
An idea. What gets in the way, what would help, what you do today instead.
config.yml turns blank issues off and sends two kinds of report elsewhere. An update row saying "no published release" or "not a version" describes the other module's repository, and links to the README section that explains each reason. A problem with Foundry itself goes to Foundry.
Two details
The labels are ones this repository already has:
bug,question,enhancement. The SDK's templates also addtriage, which does not exist here, and GitHub ignores a missing label without a word.There is no Discussions link: Discussions is off on this repository, and a contact link to a 404 is worse than none.
The README links the issue chooser under its opening lines, so a reader on GitHub has a way in.
module.jsonalready pointsbugsat the tracker for Foundry's side.All four files parse as YAML.