Skip to content

Commit b15597d

Browse files
PLeVasseurfelix91gr
andcommitted
Update GOALS.md
Co-authored-by: Félix Fischer <[email protected]>
1 parent 231fc26 commit b15597d

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
@@ -44,7 +44,9 @@ A good first step is to open a new [coding guideline issue](https://github.com/r
4444
* Make a label for each which _in theory_ is decidable or not
4545
* Include for each guideline a minimum of one compliant and one non-compliant example of code, to help illustrate its exact meaning and context.
4646
* Consider only the language reference / spec, not the tooling availability when writing the coding guidelines
47-
* Evidence-based with statistics around human error when programming Rust to support both 1. what guidelines are written and 2. why a suggestion was made
47+
* Guidelines should be evidence-based, with statistics around human error when programming Rust, to support:
48+
1. What guidelines are written, and
49+
2. Why a specific suggestion was made
4850
* 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)
4951

5052
# Non-goals

0 commit comments

Comments
 (0)