summaryrefslogtreecommitdiff
path: root/tools/README.md
diff options
context:
space:
mode:
authorYiyu Lin <linyiyu1992@gmail.com>2023-01-13 15:51:32 +0800
committerGitHub <noreply@github.com>2023-01-13 16:51:32 +0900
commita00e432297d2ae119c8e1097aec74badc886f912 (patch)
tree7380b37245e889e97a8c7b1535a1e31fddb74738 /tools/README.md
parent5707a958ac2b44d573d50260b1d0d40887662011 (diff)
chore: add `copyright_checker` tool and add the missing copyright (#17285)
Diffstat (limited to 'tools/README.md')
-rw-r--r--tools/README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/tools/README.md b/tools/README.md
index 59860ca1b..e88f8d892 100644
--- a/tools/README.md
+++ b/tools/README.md
@@ -72,3 +72,16 @@ on top, somewhat similar to `git subtree`.
2. Run `./tools/wgpu_sync.js`
3. Double check changes, possibly patch
4. Commit & send a PR with the updates
+
+## copyright_checker.js
+
+`copyright_checker.js` is used to check copyright headers in the codebase.
+
+To run the _copyright checker_:
+
+```sh
+deno run --allow-read --allow-run --unstable ./tools/copyright_checker.js
+```
+
+Then it will check all code files in the repository and report any files that
+are not properly licensed.