Docs header transparent bg

Bug triage

Triaging is the work of processing tickets that have been opened by users. Common tasks include verifying bugs, categorizing tickets, and ensuring there’s enough information to reproduce the bug for anyone who wants to try to fix it.

We’ve created an issue template to walk users through the process of how to report an issue with the Bundler project. We also have a troubleshooting guide to diagnose common problems.

Not every ticket will be a bug in Bundler’s code, but open tickets usually mean that there is something we could improve to help that user. Sometimes that means writing additional documentation or making error messages clearer.

Triaging existing issues

When you’re looking at a ticket, here are the main questions to ask:

  • Can I reproduce this bug myself?
  • Are the steps to reproduce the bug clearly documented in the ticket?
  • Which versions of Bundler (2.1.x, 2.2.x, git, etc.) manifest this bug?
  • Which operating systems (macOS, Windows, Ubuntu, CentOS, etc.) manifest this bug?
  • Which rubies (MRI, JRuby, Rubinius, etc.) and which versions (3.0.1, 3.1.2, etc.) have this bug?

Strategies for triaging a ticket: * Be sure to ask the user to output the entirety of their bundle env. Sometimes users forget to post all of their bundle env output in the issue. * After seeing the output of the user’s bundle env, try to replicate the user’s problem in your current environment. Only portions of the code base is changed in each release, so there’s a good chance your version of bundler might have the same bug. * If you’re having trouble replicating their issue with your current environment, slowly try to incorporate the user’s environment setup. As in, this is where you begin matching their environment. For example, try switching to the user’s version of Ruby, RubyGems, RVM, et cetera, step by step. * Is the user running the latest version of bundler? If not, ask them to update by running gem install bundler. There’s a chance that the newest version of bundler has already solved their problem.

If the issue still requires user information, apply the label “user feedback required”. This will help identify stale issues in the future.

If you can’t reproduce the issue, chances are good that the bug has been fixed already (hurrah!). That’s a good time to post to the ticket explaining what you did and how it worked.

If you can reproduce an issue, you’re well on your way to fixing it. :)

Fixing your triaged bug

Everyone is welcome and encouraged to fix any open bug, improve an error message or add documentation. If you have a fix or an improvement to a ticket that you would like to contribute, we have a small guide to help:

  1. Discuss the fix on the existing issue. Coordinating with everyone else saves duplicate work and serves as a great way to get suggestions and ideas if you need any.
  2. Review the pull request guide.
  3. Commit the code with at least one test covering your changes to a named branch in your fork.
  4. Send us a pull request from your bugfix branch.

You do not have to update CHANGELOG in your PR. Our release scripts will automatically prepare it from the title of each PR.


Finally, the ticket may be a duplicate of another older ticket. If you notice a ticket is a duplicate, simply comment on the ticket noting the original ticket’s number. For example, you could say “This is a duplicate of issue #42, and can be closed”.

Stale issues

Any issue that is waiting for more information is what we could consider “stale”. And the process is:

  1. If the issue is not updated in a while (2-4 weeks), we usually leave a comment saying “Hey :wave:, is this still a problem for you?”.
  2. If they don’t respond within a week or two, then we will close the ticket.
  3. If they do respond and they say it’s still an issue, then we’ll remind we are waiting for more information.
  4. If the user doesn’t provide the required information after being reminded, the ticket will be closed.
Edit this document on GitHub if you caught an error or noticed something was missing.