Skip to content

Commit bd92aa0

Browse files
docs: name and version description change (#5753)
* name and version description change Reducing redundancy by deleting repeated code and changing other slight things about those two fields.
1 parent 26f3d0b commit bd92aa0

File tree

1 file changed

+5
-10
lines changed

1 file changed

+5
-10
lines changed

docs/content/configuring-npm/package-json.md

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,9 @@ settings described in [`config`](/using-npm/config).
1818
If you plan to publish your package, the *most* important things in your
1919
package.json are the name and version fields as they will be required. The
2020
name and version together form an identifier that is assumed to be
21-
completely unique. Changes to the package should come along with changes
22-
to the version. If you don't plan to publish your package, the name and
21+
completely unique. If you don't plan to publish your package, the name and
2322
version fields are optional.
24-
25-
The name is what your thing is called.
23+
The name field contains your package name.
2624

2725
Some rules:
2826

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

5351
### version
5452

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

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

0 commit comments

Comments
 (0)