summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorColby Swandale <colby-swandale@users.noreply.github.com>2017-02-16 22:39:31 +1100
committerGitHub <noreply@github.com>2017-02-16 22:39:31 +1100
commit96a947b83d9a547994d3b1aa10d6e70be8493367 (patch)
treec2ee2aba2c2c40ee26811420879e4341301c06e4
parentc7f3d05ec03326d4c6bac6b26ba41f06f0236e66 (diff)
downloadbundler-96a947b83d9a547994d3b1aa10d6e70be8493367.tar.gz
improvements to the BUG_TRIAGE guide
-rw-r--r--doc/contributing/BUG_TRIAGE.md22
1 files changed, 10 insertions, 12 deletions
diff --git a/doc/contributing/BUG_TRIAGE.md b/doc/contributing/BUG_TRIAGE.md
index a8e9238369..d9a84ab7c7 100644
--- a/doc/contributing/BUG_TRIAGE.md
+++ b/doc/contributing/BUG_TRIAGE.md
@@ -1,37 +1,35 @@
# 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.
+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 a 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.
+We've created an [issues guide](ISSUES.md) to walk users through the process of how to report an issue with the Bundler project. We also have a [troubleshooting guide](../TROUBLESHOOTING.md) to diagnose common problems.
-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.
+Not every ticket will be a bug in Bundler's code, but open tickets usually mean that the 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 clearly stated in the ticket?
+ * Are the steps to reproduce the bug clearly documented 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'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
-Fixing issues is similar to [adding new features](../development/NEW_FEATURES.md)!
+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. 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.
-
+ 3. Review the [pull request guide](../contributing/PULL_REQUESTS.md)
+ 4. Commit the code with at least one test covering your changes to a named branch in your fork.
+ 5. Put a line in the [CHANGELOG](../../CHANGELOG.md) summarizing your changes under the next release under the “Bugfixes” heading.
+ 6. Send us a [pull request](https://help.github.com/articles/using-pull-requests) from your bugfix branch.
## Duplicates!