Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve issue reporting #3364

Open
wants to merge 16 commits into
base: development
Choose a base branch
from

Conversation

j-gynn
Copy link
Collaborator

@j-gynn j-gynn commented Jan 15, 2025

About The Pull Request

Makes a variety of improvements to the reporting of issues on the repo. To see this in action, head to my repo's Issues tab

Splits issues into the relevant groups ahead of players reporting.
image

Appropriately tags the issues with the right labels to make searching easier (this will also include the visual tag on main branch, it just doesn't in mine because I don't have it)
image

Confirm prerequisites
image

Uses a more appropriate default severity (we can't have an empty field that can stop players submitting, so this is a compromise)
image

Shows questions that are relevant to the specific issue that is being reported (UI questions ask about fullscreen, for example).
image

Why This Is Good For ClanGen

Asking the appropriate questions without making the form overwhelming is a balance to strike, especially since we can't have conditional sections (thanks GitHub...). Splitting them up allows us to ask more meaningful questions, tag things appropriately ahead of time, etc.

Changelog/Credits

@scribblecrumb
Copy link
Collaborator

Could the typo issue also include [BUG] in the title? Just so that it's grouped with the other bug related issues. I feel like it might get missed otherwise, since it's currently at the bottom of the list, below Project and Enhancement.

@j-gynn
Copy link
Collaborator Author

j-gynn commented Jan 15, 2025

Done :) Unfortunately I can't put it any higher, else I would. Sometimes GH is delightfully... opaque.

@larkgz
Copy link
Collaborator

larkgz commented Jan 15, 2025

Super minor nitpicks:

  • Can you reverse the order of the grades? It’s slightly more intuitive to me personally if it goes in order of increasing severity.
  • Can you change the seen to soon to looked at soon in grades? I know that’s the way it was before, and it's grammatically correct, but the previous phrasing causes my brain to trip slightly.

Slightly larger suggestion:

  • Can you add information on where the commit # / game version is found?

@j-gynn
Copy link
Collaborator Author

j-gynn commented Jan 17, 2025

@larkgz
Done both, added some more docs-based documentation that should hopefully be useful in other contexts too (such as "how do I find the logs folder", "how do I find the game version I'm on?" and "what's a patrol ID and do I need it for this bug report?").

@j-gynn
Copy link
Collaborator Author

j-gynn commented Jan 17, 2025

also as I'm working on this, GitHub released a new UI for issue reporting. I'm not taking screenshots again, y'all can just go see what it looks like for yourselves - it's minor.

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.

3 participants