Skip to content
New issue

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

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

Already on GitHub? # to your account

Add description to package.json #556

Merged
merged 1 commit into from
Jun 10, 2020
Merged

Add description to package.json #556

merged 1 commit into from
Jun 10, 2020

Conversation

fregante
Copy link
Contributor

@fregante fregante commented Jun 10, 2020

If description is missing from package.json, the tools that use it (like $ npm info and npmhub) will unsuccessfully try to parse the readme and get nonsense.

Before

$ npm info @zeit/ncc

@zeit/ncc@0.22.3 | MIT | deps: none | versions: 77
[![CI Status](https://github.com/zeit/ncc/workflows/CI/badge.svg)](https://github.com/zeit/ncc/actions?workflow=CI) [![codecov](https://codecov.io/gh/zeit/ncc/branch/master/graph/badge.svg)](https://codecov.io/gh/zeit/ncc)
https://github.com/zeit/ncc#readme

bin: ncc

... etc

Screen Shot 2020-06-10 at 19 32 27

After

$ npm info @zeit/ncc

@zeit/ncc@0.22.3 | MIT | deps: none | versions: 77
Simple CLI for compiling a Node.js module into a single file, together with all its dependencies, gcc-style.
https://github.com/zeit/ncc#readme

bin: ncc

... etc

@fregante fregante requested review from styfle and Timer as code owners June 10, 2020 17:32
Copy link
Member

@styfle styfle left a comment

Choose a reason for hiding this comment

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

Thanks!

@styfle styfle added the automerge Automatically merge PR once checks pass label Jun 10, 2020
@kodiakhq kodiakhq bot merged commit 89b13df into vercel:master Jun 10, 2020
@fregante fregante deleted the patch-2 branch June 10, 2020 17:53
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
automerge Automatically merge PR once checks pass
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants