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

Tidying up the Readme + Usage Screenshots #273

Merged
merged 11 commits into from
Dec 4, 2016
Merged

Tidying up the Readme + Usage Screenshots #273

merged 11 commits into from
Dec 4, 2016

Conversation

nelsonic
Copy link
Member

@nelsonic nelsonic commented Nov 17, 2016

This PR adds a couple of rules: (both set to "off")

Also tidied up the Readme a bit (removed some bloat) and added usage example screenshots: #263

@nelsonic nelsonic self-assigned this Nov 17, 2016
@nelsonic nelsonic mentioned this pull request Nov 21, 2016
@nelsonic
Copy link
Member Author

nelsonic commented Dec 4, 2016

goodparts-no-output-means-it-passes

@nelsonic
Copy link
Member Author

nelsonic commented Dec 4, 2016

A better example of Linting errors:
goodparts-showing-linting-errors

@nelsonic
Copy link
Member Author

nelsonic commented Dec 4, 2016

Auto-fix:
goodparts-autofix

@nelsonic nelsonic assigned iteles and unassigned nelsonic Dec 4, 2016
@nelsonic nelsonic changed the title [WiP] tidying up the readme Tidying up the Readme + Usage Screenshots Dec 4, 2016

> "_Any fool can write code that a computer can understand.
> "_Any fool can write code that a computer can understand. <br />
Copy link
Member

Choose a reason for hiding this comment

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

<3

"Old" Browsers/Devices are a _fact_, even if it's "*only a small percentage*"
of people, we _chose_ to
[*empathize*](http://www.merriam-webster.com/dictionary/empathize)
with them by writing code that ***Works Everywhere***<sup>TM</sup>.

3. ***Beginner-friendlyness*** or [***Shoshin***](https://en.wikipedia.org/wiki/Shoshin) - using _fewer_ JS features
Copy link
Member

Choose a reason for hiding this comment

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

Mis-spelling of friendliness but I plan to review the goodparts readme more fully in the coming days so I will correct then.

A one-line install that will ensure your project's code works everywhere.
(_or your money back!_)
`goodparts` is a "[linter](https://en.wikipedia.org/wiki/Lint_%28software%29)"
that _ensures_ your project's JavaScript code <br >
Copy link
Member

Choose a reason for hiding this comment

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

I don't think <br>s are necessary here but will suggest removing them later.

@@ -26,8 +26,8 @@ function ruleNotConfigured (rule) {
}

test('Testing All Conifgurable Rules', function (t) {
Copy link
Member

Choose a reason for hiding this comment

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

Spelling mistake here which I'll pick up in my review later in the week 👍

@iteles
Copy link
Member

iteles commented Dec 4, 2016

🎉 Thank you!

@iteles iteles merged commit 962402a into master Dec 4, 2016
@iteles iteles deleted the tidy-up branch December 4, 2016 17:15
nelsonic added a commit that referenced this pull request Dec 4, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants