Triage & Testing Issues

In context of bug repositories such as TracTrac Trac is the place where contributors create issues for bugs or feature requests much like GitHub. or GitHubGitHub GitHub is a website that offers online implementation of git repositories that can easily be shared, copied and modified by other developers. Public repositories are free to host, private repositories require a paid subscription. GitHub introduced the concept of the ‘pull request’ where code changes done in branches by contributors can be reviewed and discussed before being merged be the repository owner., triage means sorting, labeling, and closing duplicate incoming issues and testing means manually testing bug reports, questions, and feature requests. Triage is intended to be fast and to clear away clutter. Testing checks to make sure each issue is accurate and concise and has enough relevant information needed in order for a contributor who is a developer or designer to take action. Then end goal for testing and triage is a clean list of verified bug reports and feature requests that are ready for action or decision.

Testing Bugs

  1. Start with the Needs Testing or [Type] Bug label or the oldest open issues.
    Go to Needs Technical Feedback for issues that need testing from a developer perspective.
    If you are testing from a support perspective, [Type] Help Request is a good spot.
  2. Always search for duplicate issues first and close or consolidate them with a thank you.
  3. Make sure the title is accurate and descriptive and suggest a change if it isn’t.
  4. Test to make sure the issue is valid—if not, suggest closing the issue with a kind comment.
  5. Add steps to reproduce if they are missing and would add value.
  6. Add a screenshot if there isn’t already one and if it will add value.
  7. Ask clarifying questions if needed and add a the [Type] Needs More Info label.

Top ↑

Triaging Incoming Issues

  1. Start with the newest incoming issues or unlabeled open issues.
  2. Search right away for duplicate issues or issues that can be consolidated, and note them.
  3. If asking for more information would be helpful, ask right away.
  4. If the issue appears valid and urgent, test it right away.
  5. If you do not have rights to add labels, continue to the Testing Bugs section. If you do have rights to add labels, continue to the Triage for Admins section.

Top ↑

Triage for Admins

In the case of GitHub, such as the gutenberg repo, not everyone has write permissions to add labels or update titles. If you do have write permissions, you have the option to do a bit more in depth triage.
  1. Start with the newest incoming issues or unlabeled issues.
  2. Label each issue with a focus area and type.
  3. Update the title if it can be made more clear while still keeping it as short as possible.
  4. If the issue is a duplicate or can be consolidated, close it with a note and add the [Status Duplicate label.
  5. If more information is needed, add the [Status] Needs More Info  label and ask troubleshooting questions.
  6. Add workflow labels if needed, such as Needs Testing, Needs Design Feedback, or Needs Decision.

Top ↑

Good Details to Include

  • Add a screenshot whenever it makes sense. Videos should only be added if a screenshot isn’t enough to communicate the issue.
  • Version numbers for WordPress, pluginPlugin A plugin is a piece of software containing a group of functions that can be added to a WordPress website. They can extend functionality or add new features to your WordPress websites. WordPress plugins are written in the PHP programming language and integrate seamlessly with WordPress. These can be free in the Plugin Directory or can be cost-based plugin from a third-party (if applicable), OS, and browser.
  • Errors from the browser Console tab in Developer Tools.
  • Failed APIAPI An API or Application Programming Interface is a software intermediary that allows programs to interact with each other and share data in limited, clearly defined ways. calls from the browser Network tab in Developer Tools.
  • Server error logs.
When testing reported issues, try to remain as unbiased as possible. Follow the steps or explanation of the problem to the best of your ability and try to repeat it. State facts about what you tested and what happened. Stay concise, and only add a comment if you think it adds value. Note: this document is currently centered around GutenbergGutenberg The Gutenberg project is the new Editor Interface for WordPress. The editor improves the process and experience of creating new content, making writing rich content much simpler. It uses ‘blocks’ to add richness rather than shortcodes, custom HTML etc., and we expect that to change, because this is just a starting point. Please join us in #core-test on Slack to discuss!

Last updated: