From 15e9838f162c1afc69ac8824f24c878f5f5444a1 Mon Sep 17 00:00:00 2001 From: Dave Bartolomeo Date: Thu, 19 Oct 2023 17:27:21 -0400 Subject: [PATCH] Add a readme file --- shared/threat-models-ext/README.md | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 shared/threat-models-ext/README.md diff --git a/shared/threat-models-ext/README.md b/shared/threat-models-ext/README.md new file mode 100644 index 000000000000..8f292a17ec21 --- /dev/null +++ b/shared/threat-models-ext/README.md @@ -0,0 +1,7 @@ +This directory contains an extension pack for each supported threat model. Each pack should have the +same layout. To add a new threat model, just copy one of the existing packs, and update the following: + +- In `qlpack.yml`, update the `name` to `codeql/threat-$name`, where `$name` is the name of the threat model. +- In `threat.model.yml`, change the single row of the `data` property to `- ["$name"]` + +If creating these by copying and pasting becomes a burder, we can always automate the process with a script.