gavindiaz/wickra
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: document the repo-wide lockfile policy (P4) (#82)

Browse Source 
The .gitignore comment claimed package-lock.json is committed only under
bindings/node/, but examples/node/package-lock.json has also been tracked
since #80. Correct the comment and add a CONTRIBUTING 'Lockfile policy'
section spelling out every component: Cargo.lock + the two Node package-locks
are tracked; fuzz/Cargo.lock is ignored (cargo-fuzz default); the Python
package has no lockfile by PyO3 convention (pinned via Cargo.lock); the
ghost-ignored site keeps its lockfile local.
This commit is contained in:
kingchenc
2026-05-31 05:11:08 +02:00
committed by GitHub
parent 21c86f348f
commit 3093f194a2
2 changed files with 19 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.gitignore
+4 -2
View File
@@ -46,8 +46,10 @@ tarpaulin-report.html
bindings/node/*.node
bindings/node/index.d.ts
bindings/node/npm-debug.log*
# package-lock.json is committed (under bindings/node/) so contributors
# get reproducible npm installs. Top-level lockfiles still aren't expected.
# package-lock.json is committed for the tracked Node packages — bindings/node/
# and examples/node/ — so contributors get reproducible npm installs. There is
# no top-level npm package, and the ghost-ignored site/ keeps its lockfile local.
# See CONTRIBUTING.md "Lockfile policy" for the full per-component breakdown.
# WASM build output
bindings/wasm/pkg/