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.

Sign up for GitHub

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

Jump to bottom

Added a note with instructions on eslint plugin configuration #348

Merged
merged 2 commits into from
Aug 3, 2016
Merged

Added a note with instructions on eslint plugin configuration #348

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
515cadd
Added a note with instructions on eslint plugin configuration
DiegoCardoso Aug 3, 2016
fe14902
Change the format of the instructions and add screenshot.
DiegoCardoso Aug 3, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions template/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -275,7 +275,7 @@ import 'bootstrap/dist/css/bootstrap-theme.css';
```
import React, { Component } from 'react';
import { Navbar, Jumbotron, Button } from 'react-bootstrap';
```
```

Now you are ready to use the imported React Bootstrap components within your component hierarchy defined in the render method. Here is an example [App.js](https://github.com/manavsehgal/react-eshop/blob/master/src/App.js) redone using React Bootstrap.

Expand All @@ -287,7 +287,10 @@ Some editors, including Sublime Text, Atom, and Visual Studio Code, provide plug

They are not required for linting. You should see the linter output right in your terminal as well as the browser console. However, if you prefer the lint results to appear right in your editor, there are some extra steps you can do.

You would need to install an ESLint plugin for your editor first.
You would need to install an ESLint plugin for your editor first.

>Note: if you are using the `linter-eslint` plugin on Atom, make sure that **Use global ESLint installation** option is checked.
Copy link
Contributor

Choose a reason for hiding this comment

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

Let’s make this a regular paragraph, it’s too easy to skip now.

Copy link
Contributor

@gaearon gaearon Aug 3, 2016 •
edited
Loading

Choose a reason for hiding this comment

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

Better yet,

A note for Atom linter-eslint users

If you use, ...

(screenshot)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

So, create that as note with that format or a regular paragraph?

Where should I add the screenshot?

Copy link
Contributor

Choose a reason for hiding this comment

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

Let’s add a note with that format, it will be visible thanks to the screenshot.
Screenshot should be inline in the note.


Then make sure `package.json` of your project ends with this block:

```js
Expand Down