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

Packaging misses #73

Open
2 of 4 tasks
rstegg opened this issue Dec 12, 2017 · 4 comments
Open
2 of 4 tasks

Packaging misses #73

rstegg opened this issue Dec 12, 2017 · 4 comments
Assignees
Labels

Comments

@rstegg
Copy link

rstegg commented Dec 12, 2017

Here are some things I thought were missing from the packaging chapter:

[01]

  • npm view - npm view [package] versions [--json] // shows versions that you can install of a package
  • updating a package - breaking changes of a package, when not to update a package
  • documenting your packages - (refer to documenting chapter)

[02]

  • using comments inside JSON is a bit confusing, maybe needs reformatting?

Publishing and building might be able to benefit from adding some kind of follow-along or example? Just throwing that out there, I don't know how that could work.

@rstegg
Copy link
Author

rstegg commented Dec 12, 2017

For publishing and building, maybe instead of random snippets it could be following along some real codebase, and citing it at the beginning? It could benefit the author of the codebase you use for visibility as well.

@sapegin
Copy link
Member

sapegin commented Dec 12, 2017

Thanks!

updating a package - breaking changes of a package, when not to update a package

This is covered here, maybe we should move it to the packaging chapter.

using comments inside JSON is a bit confusing, maybe needs reformatting?

We mention it below, probably we should move it before the examples.

For publishing and building, maybe instead of random snippets it could be following along some real codebase, and citing it at the beginning?

That’s a good idea, but could be hard to find a package that would cover all of the examples ;-) But we can always use several.

Also take a look at my latest PR — #72 — should improve the anatomy section.

@rstegg
Copy link
Author

rstegg commented Dec 12, 2017

We mention it below, probably we should move it before the examples.

I saw, I think it doesn't really justify using it.

That’s a good idea, but could be hard to find a package that would cover all of the examples ;-) But we can always use several.

Thanks! They don't need to cover every example, but maybe some OS projects might be interested in collaborating with the book for visibility? The idea might want some extra opinions, it's just a pitch :)

@rstegg
Copy link
Author

rstegg commented Dec 12, 2017

I saw, I think it doesn't really justify using it.

After second thought, there isn't really any better way of explaining a JSON file.

Also take a look at my latest PR — #72 — should improve the anatomy section.

I'll check it out 👍

@sapegin sapegin self-assigned this Dec 14, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants