summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThe Bundler Bot <bot@bundler.io>2017-02-17 06:28:45 +0000
committerThe Bundler Bot <bot@bundler.io>2017-02-17 06:28:45 +0000
commit1428c30592648a3e2f40a4eb3283d8e9b41d4488 (patch)
treef8920144be056365802161b7018683ce17da4645
parent713ea1086efe9545a1c473a6d59ec6a0f6e1b97a (diff)
parentefa9d9c9d8c5a06b31c4e6839e4b4c73b4ace14f (diff)
downloadbundler-1428c30592648a3e2f40a4eb3283d8e9b41d4488.tar.gz
Auto merge of #5437 - colby-swandale:bug-triage, r=indirect
improvements to the BUG_TRIAGE guide \cc @indirect What we were discussing earlier This PR consists of several changes like: * Update references to guides (troubleshooting.md & issues.md specifically) * Adding references to existing guides (pull_request.md) * General cleanup, adding clarity etc
-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..aa535a0f45 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 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.
+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!