diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index df3b926f1f..453d8876ed 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,9 +14,7 @@ Please read https://reactjs.org/ and the Code of Conduct before opening an issue ## Think You Found a Bug? -Please provide a test case of some sort. Best is a pull request with a failing test. Next is a link to codepen/jsbin or repository that illustrates the bug. Finally, some copy/pastable code is acceptable. - -If you don't provide a test case, the issue will be closed. +Please provide a test case of some sort. Best is a pull request with a failing test. Next is a link to CodePen/JS Bin or repository that illustrates the bug. Finally, some copy/pastable code is acceptable. ## Proposing New or Changed API? diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index 3794a97447..5e22215ab4 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -3,7 +3,7 @@ Thank you for contributing! Have a usage question? ====================== -Questions *might* be closed without comment, sometimes we just don't have time for them. Before you ask one, here are some resources to get help first: +The issue tracker isn't the best place for usage questions. This format is not well-suited for Q&A, and questions here don't have as much visibility as they do elsewhere. Before you ask a question, here are some resources to get help first: - Do the tutorial: https://github.com/reactjs/react-router-tutorial - Read the docs: https://github.com/reactjs/react-router/tree/latest/docs diff --git a/README.md b/README.md index 94fc9cec70..534e5f760b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# react-router [![Travis][build-badge]][build] [![npm package][npm-badge]][npm] +# React Router [![Travis][build-badge]][build] [![npm package][npm-badge]][npm] -[`react-router`](https://www.npmjs.com/package/react-router) is a complete routing library for [React](https://facebook.github.io/react). +React Router is a complete routing library for [React](https://facebook.github.io/react). React Router keeps your UI in sync with the URL. It has a simple API with powerful features like lazy code loading, dynamic route matching, and location transition handling built right in. Make the URL your first thought, not an after-thought. @@ -10,19 +10,18 @@ React Router keeps your UI in sync with the URL. It has a simple API with powerf ### Docs & Help - [Tutorial – do this first!](https://github.com/reactjs/react-router-tutorial) -- [Guides and API docs](https://github.com/reactjs/react-router/tree/master/docs) +- [Guides and API docs](/docs) - [Troubleshooting guide](https://github.com/reactjs/react-router/blob/master/docs/Troubleshooting.md) - [Changelog](/CHANGES.md) - [Stack Overflow](http://stackoverflow.com/questions/tagged/react-router) -- [CodePen boilerplate](http://codepen.io/anon/pen/xwQZdy?editors=001) - Please use for bug reports +- [CodePen boilerplate](http://codepen.io/anon/pen/xwQZdy?editors=001) for bug reports **Older Versions:** - 0.13.x - [docs](https://github.com/reactjs/react-router/tree/0.13.x/docs/guides) / [code](https://github.com/reactjs/react-router/tree/0.13.x) / [upgrade guide](https://github.com/reactjs/react-router/blob/master/upgrade-guides/v1.0.0.md) - 1.0.x - [docs](https://github.com/reactjs/react-router/tree/1.0.x/docs) / [code](https://github.com/reactjs/react-router/tree/1.0.x) / [upgrade guide](https://github.com/reactjs/react-router/blob/master/upgrade-guides/v2.0.0.md) -For questions and support, please visit [our channel on Reactiflux](https://discord.gg/0ZcbPKXt5bYaNQ46) or [Stack Overflow](http://stackoverflow.com/questions/tagged/react-router). The issue tracker is *exclusively* for bug reports and feature requests. +For questions and support, please visit [our channel on Reactiflux](https://discord.gg/0ZcbPKXt5bYaNQ46) or [Stack Overflow](http://stackoverflow.com/questions/tagged/react-router). ### Browser Support @@ -120,7 +119,7 @@ render(( ), document.body) ``` -See more in the [Introduction](https://github.com/reactjs/react-router/tree/master/docs/Introduction.md), [Guides](https://github.com/reactjs/react-router/tree/master/docs/guides/README.md), and [Examples](https://github.com/reactjs/react-router/tree/master/examples). +See more in the [Introduction](/docs/Introduction.md), [Guides](/docs/guides/README.md), and [Examples](/examples). ### Versioning and Stability diff --git a/package.json b/package.json index 67bc5f1464..65c90ddb93 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "react-router", "version": "2.2.4", - "description": "A complete routing library for React.js", + "description": "A complete routing library for React", "files": [ "*.md", "docs",