diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 753accd3ca..fbafd25b29 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,8 +18,8 @@ the preferred channel for [bug reports](#bug-reports), [features requests](#feat and [submitting pull requests](#pull-requests), but please respect the following restrictions: -* Please **do not** use the issue tracker for personal support requests (use - [Stack Overflow](http://stackoverflow.com/) or IRC). +* Please **do not** use the issue tracker for personal support requests. Stack + Overflow ([`twitter-boostrap`](http://stackoverflow.com/questions/tagged/twitter-bootstrap) tag) or [IRC](https://github.com/twbs/bootstrap/blob/master/README.md#community) are better places to get help. * Please **do not** derail or troll issues. Keep the discussion on topic and respect the opinions of others. @@ -44,12 +44,15 @@ Guidelines for bug reports: 3. **Isolate the problem** — ideally create a [reduced test case](http://css-tricks.com/6263-reduced-test-cases/) and a live example. + [This JS Bin](http://jsbin.com/EBAwOkOK/1) is a helpful template. + A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What browser(s) and OS -experience the problem? What would you expect to be the outcome? All these -details will help people to fix any potential bugs. +experience the problem? Do other browsers show the bug differently? What +would you expect to be the outcome? All these details will help people to fix +any potential bugs. Example: diff --git a/README.md b/README.md index ebaf126644..5ba0d77c05 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,17 @@ Bootstrap is a sleek, intuitive, and powerful front-end framework for faster and To get started, check out ! +## Table of contents + - [Quick start](#quick-start) + - [Bugs and feature requests](#bugs-and-feature-requests) + - [Documentation](#documentation) + - [Compiling CSS and JavaScript](#compiling-css-and-javascript) + - [Contributing](#contributing) + - [Community](#community) + - [Versioning](#versioning) + - [Authors](#authors) + - [Copyright and license](#copyright-and-license) ## Quick start @@ -44,10 +54,7 @@ We provide compiled CSS and JS (`bootstrap.*`), as well as compiled and minified ## Bugs and feature requests -Have a bug or a feature request? [Please open a new issue](https://github.com/twbs/bootstrap/issues). Before opening any issue, please search for existing issues and read the [Issue Guidelines](https://github.com/necolas/issue-guidelines), written by [Nicolas Gallagher](https://github.com/necolas/). - -You may use [this JS Bin](http://jsbin.com/EBAwOkOK/1) as a template for your bug reports. - +Have a bug or a feature request? Please first read the [issue guidelines](https://github.com/twbs/bootstrap/blob/master/CONTRIBUTING.md#using-the-issue-tracker) and search for existing and closed issues. If your problem or idea is not addressed yet, [please open a new issue](https://github.com/twbs/bootstrap/issues/new). ## Documentation @@ -124,6 +131,7 @@ Keep track of development and community news. - Follow [@twbootstrap on Twitter](http://twitter.com/twbootstrap). - Read and subscribe to [The Official Bootstrap Blog](http://blog.getbootstrap.com). - Chat with fellow Bootstrappers in IRC. On the `irc.freenode.net` server, in the `##twitter-bootstrap` channel. +- Impelementation help may be found at Stack Overflow (tagged [`twitter-bootstrap`](http://stackoverflow.com/questions/tagged/twitter-bootstrap)).