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

Add npm scripts #944

Merged
merged 2 commits into from
Jul 6, 2017
Merged

Add npm scripts #944

merged 2 commits into from
Jul 6, 2017

Conversation

RyanZim
Copy link
Contributor

@RyanZim RyanZim commented Apr 24, 2017

https://github.com/RyanZim/awesome-npm-scripts

I couldn't find an awesome list relating to npm scripts and using npm as a build tool, so I wrote one. This is a resubmission of #775; the list has been expanded since then.

By submitting this pull request I confirm I've read and complied with the below requirements.

Please read it multiple times. I spent a lot of time on these guidelines and most people miss a lot.

  • I have read and understood the contribution guidelines and the instructions for creating a list.
  • This pull request has a descriptive title.
    For example, Add Name of List, not Update readme.md or Add awesome list.
  • The entry in the Awesome list should:
    • Include a short description about the list project/theme. It should not describe the list itself.
      Example: - [Fish](…) - User-friendly shell.
    • Be added at the bottom of the appropriate category.
  • The list I'm submitting complies with these requirements:
    • Has been around for at least 30 days.
      That means 30 days from either the first real commit or when it was open-sourced. Whatever is most recent.
    • It's the result of hard work and the best I could possibly produce.
    • Non-generated Markdown file in a GitHub repo.
    • The repo should have the following GitHub topics set: awesome-list, awesome, list. I encourage you to add more relevant topics.
    • Not a duplicate.
    • Includes a succinct description of the project/theme at the top of the readme. (Example)
    • Only has awesome items. Awesome lists are curations of the best, not everything.
    • Includes a project logo/illustration whenever possible.
      • Placed at the top-right of the readme. (Example)
      • The image should link to the project website or any relevant website.
      • The image should be high-DPI. Set it to maximum half the width of the original image.
    • Entries have a description, unless the title is descriptive enough by itself. It rarely is though.
    • Has the Awesome badge on the right side of the list heading,
    • Has a Table of Contents section.
      • Should be named Contents, not Table of Contents.
      • Should be the first section in the list.
    • Has an appropriate license.
      • That means something like CC0, not a code licence like MIT, BSD, Apache, etc.
      • If you use a license badge, it should be SVG, not PNG.
    • Has contribution guidelines.
      • The file should be named contributing.md. Casing is up to you.
    • Has consistent formatting and proper spelling/grammar.
      • Each link description starts with an uppercase character and ends with a period.
        Example: - [AVA](…) - JavaScript test runner.
      • Drop all the A / An prefixes in the descriptions.
      • Consistent naming. For example, Node.js, not NodeJS or node.js.
    • Doesn't include a Travis badge.
      You can still use Travis for list linting, but the badge has no value in the readme.
  • Go to the top and read it again.

@legodude17
Copy link

Not followed:

  • Drop all the A / An prefixes in the descriptions.
  • Each link description starts with an uppercase character and ends with a period.

Advanced front-end automation with npm scripts - by Kate Hudson

This one needs an actual description.

@RyanZim
Copy link
Contributor Author

RyanZim commented Apr 28, 2017

@legodude17 Thanks for the review. Fixed (I think)!

@legodude17
Copy link

Suggestions:

  • Actually describe what watch and onchange do.
  • Find a way to reword the Cross-Platform Utilities section so less of them start with the words cross-platform
  • Describe what shx is

@RyanZim
Copy link
Contributor Author

RyanZim commented Apr 28, 2017

Hey, thanks for the suggestions.

watch and onchange both do the same thing; they watch files. The only difference is the command syntax. Would it be OK to describe what they do directly under the heading and leave the individual descriptions pretty close to what they are?

@legodude17
Copy link

Yeah, that would make sense, as long as you make it clear that the description applies to both of them.

@RyanZim
Copy link
Contributor Author

RyanZim commented May 13, 2017

@legodude17 Can you take a look at RyanZim/awesome-npm-scripts#18?

@legodude17
Copy link

@RyanZim Very nice!

I would suggest you improve the description of shx, like give examples.

@RyanZim
Copy link
Contributor Author

RyanZim commented May 16, 2017

@legodude17
Copy link

@RyanZim Very nice! I don't think I have anything else to add.

Any thoughts @sindresorhus?

@RyanZim
Copy link
Contributor Author

RyanZim commented May 23, 2017

Any action on this?

@RyanZim
Copy link
Contributor Author

RyanZim commented Jun 5, 2017

@sindresorhus ping?

@sindresorhus
Copy link
Owner

Includes a succinct description of the project/theme at the top of the readme. (Example)

⬆️

@sindresorhus sindresorhus changed the title Add awesome-npm-scripts Add npm scripts Jun 9, 2017
@RyanZim
Copy link
Contributor Author

RyanZim commented Jun 9, 2017

@sindresorhus Change LGTM

@RyanZim
Copy link
Contributor Author

RyanZim commented Jul 1, 2017

@sindresorhus Updated

@sindresorhus sindresorhus merged commit d111340 into sindresorhus:master Jul 6, 2017
@sindresorhus
Copy link
Owner

Added :)

@RyanZim RyanZim deleted the patch-2 branch July 6, 2017 20:26
@RyanZim
Copy link
Contributor Author

RyanZim commented Jul 6, 2017

Thanks a lot!

moebiusmania pushed a commit to moebiusmania/awesome that referenced this pull request Jul 21, 2017
parinck pushed a commit to parinck/awesome that referenced this pull request Jul 23, 2017
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.

None yet

3 participants