Skip to content

Commit 2ab3fbc

Browse files
committed
add instructions to not miss package-lock.json changes
1 parent 6e200b2 commit 2ab3fbc

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

.github/PULL_REQUEST_TEMPLATE.md

+3
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,7 @@ _Description of changes:_
44

55
_Target (OCI, Managed Runtime, both):_
66

7+
## Checklist
8+
- [ ] I have run `npm install` to generate the `package-lock.json` correctly and included it in the PR.
9+
710
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

README.md

+7
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,13 @@ Then,
165165
* to run integration tests: `make test-integ`
166166
* to run smoke tests: `make test-smoke`
167167

168+
### Raising a PR
169+
When modifying dependencies (`package.json`), make sure to:
170+
1. Run `npm install` to generate an updated `package-lock.json`
171+
2. Commit both `package.json` and `package-lock.json` together
172+
173+
We require package-lock.json to be checked in to ensure consistent installations across development environments.
174+
168175
### Troubleshooting
169176

170177
While running integration tests, you might encounter the Docker Hub rate limit error with the following body:

0 commit comments

Comments
 (0)