Skip to content

Commit e9b7bb8

Browse files
committed
feat: address what we provide for machine-readable artifacts
1 parent 5d829dd commit e9b7bb8

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

GOALS.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,9 @@ There will be an addendum which covers how various safety standards like ISO 262
3030
* We aim to produce evidence-based guidelines, with statistics around human error when programming Rust, to support:
3131
1. What guidelines are written, and
3232
2. Why a specific suggestion was made
33-
* We will produce the guidelines in an artifact that's easily machine readable and consistent format to make it easier to consume by tool vendors as a baseline (e.g. multiple JSON files, one per language piece, also potentially one large JSON concatenated together)
33+
* We will produce the guidelines in an artifact that's easily machine readable and consistent format to make it easier to consume by tool vendors to some minimal viable artifact.
34+
* a `needs.json` containing the contents of the coding guidelines
35+
* a `guidelines-ids.json` which has hashes of the guidelines contents which can be used to check against and break a tool vendors build until audit is performed
3436

3537
# Explicit non-goals
3638

0 commit comments

Comments
 (0)