Skip to content

Commit 0c25a0c

Browse files
committed
update docs
1 parent 4b111f4 commit 0c25a0c

File tree

1 file changed

+29
-6
lines changed

1 file changed

+29
-6
lines changed

docs/how-to-update-npm-packages.md renamed to docs/managing-updates.md

Lines changed: 29 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,27 @@
1-
# How to update NPM packages
1+
# Managing updates
2+
3+
## Within the Epic Stack
4+
5+
When you create a new project with the Epic Stack, a bunch of code is generated
6+
for you. This code is completely yours and there is no way to update it other
7+
than making manual changes. This is both a good thing and a bad thing. It's good
8+
in the sense that you can tweak it to fit your specific use cases. But it's a
9+
challenge because as the Epic Stack gets improvements there's no way to get
10+
those automatically. You have to keep track of the improvements in the Epic
11+
Stack and make those updates yourself.
12+
13+
You shouldn't feel compelled to keep up-to-date with the latest of the Epic
14+
Stack template. If what you're using is working fine for you then just keep
15+
going with it. Only adopt changes as you feel the need to do so. Feel free to
16+
peruse
17+
[the Epic Stack's commit history](https://github.com/epicweb-dev/epic-stack/commits/main)
18+
anytime you'd like to see what updates could be made to your project.
19+
20+
## How to update NPM dependencies
21+
22+
Another part of the Epic Stack is the dependencies of the project. These you
23+
will also have to keep up-to-date yourself, but there is a bit of an automated
24+
process to help you.
225

326
It’s important to update your packages to get new features, bug fixes, and
427
security patches.
@@ -7,7 +30,7 @@ that will help you safely make those updates. You can watch
730
[this youtube video](https://www.youtube.com/watch?v=0XQXGx3lLaU) for a
831
demonstration of how to do this.
932

10-
## See a list of packages that can be updated
33+
### See a list of packages that can be updated
1134

1235
NPM packages follow [semantic versioning](https://semver.org). This command will
1336
show you which packages can be updated and which major, minor, or patch versions
@@ -19,11 +42,11 @@ npx npm-check-updates
1942

2043
Notice the colors:
2144

22-
- Green = (nonmajor version zero) patch updates
45+
- Green = (non-major version zero) patch updates
2346
- Cyan = minor updates
2447
- Red = major or [version zero (0.y.z)](https://semver.org/#spec-item-4) updates
2548

26-
## Update green patch versions first, all at once
49+
### Update green patch versions first, all at once
2750

2851
Since green patch version updates are meant for backward-compatible bug fixes,
2952
it's ok to update them all at once.
@@ -55,7 +78,7 @@ git add .
5578
git commit -m "Updated patch versions"
5679
```
5780

58-
## Update cyan minor versions second, one by one
81+
### Update cyan minor versions second, one by one
5982

6083
Minor version updates introduce new features in a backward-compatible way. This
6184
is exciting and it's good practice to take some time to explore the new
@@ -89,7 +112,7 @@ git add .
89112
git commit -m "Updated minor versions"
90113
```
91114

92-
## Update red versions third, one by one
115+
### Update red versions third, one by one
93116

94117
Red updates can happen on patch or minor versions (for zero major version
95118
(0.y.z) packages) or major versions. Either way, they could be breaking changes.

0 commit comments

Comments
 (0)