diff --git a/doc/contributing/maintaining-brotli.md b/doc/contributing/maintaining-brotli.md new file mode 100644 index 00000000000000..e8b0ddbe97e3c0 --- /dev/null +++ b/doc/contributing/maintaining-brotli.md @@ -0,0 +1,26 @@ +# Maintaining brotli + +The [brotli](https://github.com/google/brotli) dependency is used for +the homonym generic-purpose lossless compression algorithm. + +## Updating brotli + +The `tools/dep_updaters/update-brotli.sh` script automates the update of the +brotli source files. + +Check that Node.js still builds and tests. + +## Committing postject + +1. Add brotli: + ```console + $ git add deps/brotli + ``` +2. Commit the changes: `git commit`. +3. Add a message like: + + ```text + deps,test: update brotli to + + Updated as described in doc/contributing/maintaining-brotli.md. + ```