From 30b42bf91010327bc8c1dda6ed54286f24b7bf58 Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Sun, 24 Apr 2016 18:53:03 -0700 Subject: [PATCH] Clearer section headings, more succinct copy --- ISSUE_TEMPLATE.md | 41 ++++++++++++++++------------------------- 1 file changed, 16 insertions(+), 25 deletions(-) diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index fc4b594e5b..6c23ffa387 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -1,31 +1,22 @@ -If you're reporting a bug: +Before opening an issue: -* Have you [searched for duplicate issues, including closed issues?]( https://github.com/twbs/bootstrap/issues?utf8=%E2%9C%93&q=is%3Aissue ): -* Have you [validated]( http://validator.w3.org/nu/ ) your page's HTML?: -* Have you [linted]( https://github.com/twbs/bootlint#in-the-browser ) your page's HTML?: -* What version of Bootstrap are you using?: - * If you're not using the latest version (3.3.6 or 4.0.0-alpha.2), please try upgrading first. -* Which OS are you using?: - * [Windows, Mac OS X, Android, iOS, Win10 Mobile] -* Which browser are you using?: - * [Chrome, Firefox, Safari, IE, MS Edge, Opera 15+, Android Browser] -* What versions of your OS and browser are you using?: -* What's the URL of your [reduced test case]( https://css-tricks.com/reduced-test-cases/ )?: - * If you don't provide a reduced test case, your issue may get summarily closed. - * Please use [BootstrapCDN]( https://www.bootstrapcdn.com ) and [JS Bin]( https://jsbin.com ) (or JSFiddle, CodePen, etc.) for your testcase. - * Full, non-simplified production webpages don't qualify as reduced test cases. +- [Search for duplicate or closed issues](https://github.com/twbs/bootstrap/issues?utf8=%E2%9C%93&q=is%3Aissue) +- [Validate](http://validator.w3.org/nu/) and [lint](https://github.com/twbs/bootlint#in-the-browser) any HTML to avoid common problems +- Prepare a [reduced test case](https://css-tricks.com/reduced-test-cases/) for any bugs +- Read the [contributing guidelines](https://github.com/twbs/bootstrap/blob/master/CONTRIBUTING.md) ---- +When asking general "how to" questons: -If you need help debugging your specific webpage or have a "How do I...?" question, -**DON'T** open an issue. Ask for help on StackOverflow, IRC, or Slack instead. -See https://github.com/twbs/bootstrap/blob/master/README.md#community for links to those personal support forums. +- Please do not open an issue here +- Instead, ask for help on [StackOverflow, IRC, or Slack](https://github.com/twbs/bootstrap/blob/master/README.md#community) ---- +When reporting a bug, include: -If you have a feature request: +- Operating system and version (Windows, Mac OS X, Android, iOS, Win10 Mobile) +- Browser and version (Chrome, Firefox, Safari, IE, MS Edge, Opera 15+, Android Browser) +- Reduced test cases and potential fixes using [JS Bin](https://jsbin.com) -* Have you [searched for duplicate issues, including closed issues?]( https://github.com/twbs/bootstrap/issues?utf8=%E2%9C%93&q=is%3Aissue ): -* Note that your request will only be considered for Bootstrap 4. - * [Bootstrap 3 is no longer receiving new features.]( https://github.com/twbs/bootstrap/blob/master/CONTRIBUTING.md#feature-requests ) -* Please describe your idea in as much detail as possible. (Terse or unclear requests may get summarily closed.) +When suggesting a feature, include: + +- As much detail as possible for what we should add and why it's important to Bootstrap +- Relevant links to prior art, screenshots, or live demos whenever possible