Skip to content

Commit

Permalink
docs: name and version description change (#5753)
Browse files Browse the repository at this point in the history
* name and version description change

Reducing redundancy by deleting repeated code and changing other slight things about those two fields.
  • Loading branch information
dominikgorczyca committed Nov 1, 2022
1 parent 26f3d0b commit bd92aa0
Showing 1 changed file with 5 additions and 10 deletions.
15 changes: 5 additions & 10 deletions docs/content/configuring-npm/package-json.md
Expand Up @@ -18,11 +18,9 @@ settings described in [`config`](/using-npm/config).
If you plan to publish your package, the *most* important things in your
package.json are the name and version fields as they will be required. The
name and version together form an identifier that is assumed to be
completely unique. Changes to the package should come along with changes
to the version. If you don't plan to publish your package, the name and
completely unique. If you don't plan to publish your package, the name and
version fields are optional.

The name is what your thing is called.
The name field contains your package name.

Some rules:

Expand Down Expand Up @@ -52,12 +50,9 @@ A name can be optionally prefixed by a scope, e.g. `@myorg/mypackage`. See

### version

If you plan to publish your package, the *most* important things in your
package.json are the name and version fields as they will be required. The
name and version together form an identifier that is assumed to be
completely unique. Changes to the package should come along with changes
to the version. If you don't plan to publish your package, the name and
version fields are optional.
Changes to the package should come along with changes to the version.
You can show developers how much they need to adjust on a new update by
using [semantic versioning](../../about-semantic-versioning)

Version must be parseable by
[node-semver](https://github.com/npm/node-semver), which is bundled with
Expand Down

0 comments on commit bd92aa0

Please sign in to comment.