Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: unify package name styling #307

Merged
merged 4 commits into from
Aug 30, 2017
Merged

docs: unify package name styling #307

merged 4 commits into from
Aug 30, 2017

Conversation

morajabi
Copy link
Contributor

fixes #273

Feel free to add any comment.

Copy link
Owner

@kulshekhar kulshekhar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm apart from that one comment

README.md Outdated
@@ -71,25 +71,25 @@ This setup should allow you to write Jest tests in Typescript and be able to loc
From version `"jest": "17.0.0"` we are using same MAJOR.MINOR as [`Jest`](https://github.com/facebook/jest).
For `"jest": "< 17.0.0"` use `"ts-jest": "0.1.13"`. Docs for it see [here](https://github.com/kulshekhar/ts-jest/blob/e1f95e524ed62091736f70abf63530f1f107ec03/README.md).

You can try using `ts-jest` with `jest@test`; use at your own risk! (And file an issue if you find problems.)
You can try using ts-jest with *jest@test*; use at your own risk! (And file an issue if you find problems.)
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think backticks provide better readability for package@versions

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I've had doubt about that.

@kulshekhar
Copy link
Owner

I don't think there's any harm in removing the "VS Code limitations" section from the readme as part of this PR (as discussed in #212). Thoughts?

@morajabi
Copy link
Contributor Author

OK, wait a moment

@morajabi
Copy link
Contributor Author

morajabi commented Aug 30, 2017

@kulshekhar I ran doc command and it updated collaborator-guideline too. Also it added Using .babelrc (it seems we haven't ran doc since then).

Isn't that a problem to you?

@kulshekhar
Copy link
Owner

I'm not sure yet but I don't see a problem. Push the changes in. I'll take a look.

@GeeWee
Copy link
Collaborator

GeeWee commented Aug 30, 2017

Yeah I think I forgot to run doc back then.

@morajabi morajabi merged commit 9cb6f86 into master Aug 30, 2017
@morajabi morajabi deleted the unify-pkg-name branch August 30, 2017 10:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Choose a style for writing package name itself
3 participants