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

Documentation - how to write a bug ticket well #9508

Open
TKDickson opened this issue Aug 29, 2024 · 3 comments
Open

Documentation - how to write a bug ticket well #9508

TKDickson opened this issue Aug 29, 2024 · 3 comments
Assignees
Labels
documentation QA and Release Label identifies this work is done on the QA and Release Team

Comments

@TKDickson
Copy link
Contributor

Documentation on how to fill out a bug ticket well, including things like:

  • Required vs not required fields
  • Context/why we do certain things
  • Examples of well-filled out tickets
  • FYI on the bug scrub process (so if you mess things up at least there's a backstop)
  • Linking to said documentation from the internal bug ticket template

Will help make expectations around this clearer, for folks onboarding.

Credit to @brea11y for pointing out this was a good idea.

@TKDickson TKDickson added documentation QA and Release Label identifies this work is done on the QA and Release Team labels Aug 29, 2024
@DJUltraTom
Copy link
Contributor

@TKDickson is the intent for this ticket to create a "How to" article, update the bug ticket template or both?
If a document/article is the desired output, where should this document live?

@TKDickson
Copy link
Contributor Author

@DJUltraTom mostly a how-to article, but if you find that updating the ticket template along the way also makes sense, go for it. It should live on the QA section of the doc site, probably as a subpage of the Quality Assurance Process section.

@DJUltraTom
Copy link
Contributor

Started working on a "how to article" in Github, and realized this needs more peer input than I'll be able to accomplish before EOD. moving this to "backlog" and after the "gap" this can be revisited.
A few points that can be emphasized are:

  • Use the "Bug report Template"
  • Specify the Require fields and Why.
  • Screenshot examples for use from completed GH tickets (not the ZH tickets)
  • Brief explanation of scrub process and ticket flow. (may change based on team structure)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation QA and Release Label identifies this work is done on the QA and Release Team
Projects
None yet
Development

No branches or pull requests

2 participants