Skip to content

Commit fc5ba64

Browse files
committed
docs: clarify what we're providing in a machine readable format and for what purpose
1 parent 1eae235 commit fc5ba64

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

GOALS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ There will be an addendum which covers how various safety standards like ISO 262
3131
* We aim to produce evidence-based guidelines, with statistics around human error when programming Rust, to support:
3232
1. What guidelines are written, and
3333
2. Why a specific suggestion was made
34-
* We will produce the guidelines in an artifact that's easily machine readable and of a consistent format, to make it easier to consume by tool vendors to some minimal viable artifact.
34+
* We will produce the guidelines and a hash of their contents in a machine readable and consistent format, to make consumption simpler for tool vendors. These artifacts are:
3535
* a `needs.json` containing the contents of the coding guidelines
3636
* a `guidelines-ids.json` which has hashes of the guidelines' contents, which can be used to check against (and break) a tool vendor's build, until an audit is performed
3737

0 commit comments

Comments
 (0)