aboutsummaryrefslogtreecommitdiffstats
path: root/doc/contributing/BUG_TRIAGE.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/contributing/BUG_TRIAGE.md')
-rw-r--r--doc/contributing/BUG_TRIAGE.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/doc/contributing/BUG_TRIAGE.md b/doc/contributing/BUG_TRIAGE.md
new file mode 100644
index 00000000..a8e92383
--- /dev/null
+++ b/doc/contributing/BUG_TRIAGE.md
@@ -0,0 +1,38 @@
+# Bug triage
+
+Triage is the work of processing tickets that have been opened into actionable issues, feature requests, or bug reports. That includes verifying bugs, categorizing the ticket, and ensuring there's enough information to reproduce the bug for anyone who wants to try to fix it.
+
+We've created an [issues guide](ISSUES.md) to walk Bundler users through the process of troubleshooting issues and reporting bugs.
+
+If you'd like to help, awesome! You can [report a new bug](https://github.com/bundler/bundler/issues/new) or browse our [existing open tickets](https://github.com/bundler/bundler/issues).
+
+Not every ticket will point to 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, sometimes that means making error messages clearer, and sometimes that means explaining to a user that they need to install git to use git gems.
+
+## 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 clearly stated in the ticket?
+ * Which versions of Bundler (1.1.x, 1.2.x, git, etc.) manifest this bug?
+ * Which operating systems (OS X, Windows, Ubuntu, CentOS, etc.) manifest this bug?
+ * Which rubies (MRI, JRuby, Rubinius, etc.) and which versions (1.8.7, 1.9.3, etc.) have this bug?
+
+If you can't reproduce an issue, chances are good that the bug has been fixed (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
+
+Fixing issues is similar to [adding new features](../development/NEW_FEATURES.md)!
+
+ 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. Base your commits on the correct branch. Bugfixes for 1.x versions of Bundler should be based on the matching 1-x-stable branch.
+ 3. Commit the code and at least one test covering your changes to a named branch in your fork.
+ 4. Put a line in the [CHANGELOG](../../CHANGELOG.md) summarizing your changes under the next release under the “Bugfixes” heading.
+ 5. Send us a [pull request](https://help.github.com/articles/using-pull-requests) from your bugfix branch.
+
+
+## Duplicates!
+
+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”.