Packaging misses
rstegg opened this issue · 4 comments
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.
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.
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.
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 :)