Tweak project-level copy a bit #3337

Merged
merged 1 commit into from Apr 18, 2016

Projects

None yet

2 participants

@taion
Contributor
taion commented Apr 16, 2016

No description provided.

@taion taion Tweak project-level copy a bit
2e487d8
@taion taion commented on the diff Apr 16, 2016
CONTRIBUTING.md
@@ -14,9 +14,7 @@ Please read https://reactjs.org/ and the Code of Conduct before opening an issue
<a name="bug"/>
## 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.
@taion
taion Apr 16, 2016 Contributor

Maybe? I think it's okay to ask for test cases when they're helpful, but sometimes it's simple enough to not need a test case.

@timdorr
timdorr Apr 18, 2016 Collaborator

The pessimist in me says people are going to ignore this no matter what you write.

@taion taion commented on the diff Apr 16, 2016
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:
@taion
taion Apr 16, 2016 Contributor

I feel like this is a bit more gentle – "you should go to other places because they're better".

@timdorr
timdorr Apr 18, 2016 Collaborator

Positive reinforcement is more effective than negative.

@taion taion commented on the diff Apr 16, 2016
README.md
-[`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).
@taion
taion Apr 16, 2016 Contributor

Just a bunch of copy-editing tweaks; I updated repo description to say "A complete routing library for React" as well.

@timdorr
timdorr Apr 18, 2016 Collaborator

What was it before?

@taion
taion Apr 18, 2016 Contributor

"for React.js"

@taion taion commented on the diff Apr 16, 2016
README.md
@@ -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)
@taion
taion Apr 16, 2016 Contributor

These links don't need to be fully qualified. npm resolves these correctly as well, e.g. for the /SPONSORS.md link below.

@timdorr
timdorr Apr 18, 2016 Collaborator

Depending on how we do the branching for 3.0, we might need to make this a fully-qualified URL again to link to the right branch for docs.

@timdorr timdorr merged commit d6851ca into master Apr 18, 2016

2 checks passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
coverage/coveralls Coverage remained the same at 94.643%
Details
@timdorr timdorr deleted the edit-docs branch Apr 18, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment