Skip to content

Commit 4f6a047

Browse files
committed
Move goals into GOALS.md
1 parent 303fa89 commit 4f6a047

File tree

2 files changed

+61
-0
lines changed

2 files changed

+61
-0
lines changed

GOALS.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Overview
2+
3+
## Elevator pitch
4+
5+
Coding guidelines are available within this repository, potentially deployed to a website mdBook-style.
6+
7+
## Detailed
8+
9+
In general these coding guidelines should be a set of rules of do / do not do with examples which should cover all "general" aspects of the Rust programming language, e.g. enums, structs, traits, and so on. We can use the [FLS](https://rust-lang.github.io/fls/index.html) as a means to ensure we have reasonable coverage of the language.
10+
11+
There should be an addendum which covers how various safety standards like ISO 26262 map onto the coding guidelines.
12+
13+
This serves as a tracking issue which is why it's considered "XL". Work will get logged against this in smaller chunks!
14+
15+
# Way of work
16+
17+
## Outline & issue breakdown
18+
19+
We will use the Coding Guidelines Work Items [board](https://github.com/orgs/rustfoundation/projects/1) as a means to break the work down into smaller chunks that can be tackled in a reasonable manner.
20+
21+
## Contribution of existing guidelines
22+
23+
We are very open to receiving contributed coding guidelines in whole or in part and wholly originally contributions based on learnings from past organizational experience using Rust in safety-critical projects.
24+
25+
## Contribution of a new guideline
26+
27+
A good first step is to open a new [coding guideline issue](https://github.com/rustfoundation/safety-critical-rust-coding-guidelines/issues/new?template=CODING-GUIDELINE.yml).
28+
29+
# Goals
30+
31+
* Coding guidelines that make a "best effort" attempt at cataloging common pieces (e.g. struct or unsafe) of the Rust programming language and how they fit into a safety-critical project
32+
* We will use [MISRA Compliance: 2020](https://misra.org.uk/app/uploads/2021/06/MISRA-Compliance-2020.pdf) for categorization
33+
* Includes rationale with links to parts of the Rust Project and wider Rust community for guidance
34+
* Could later be refined according to various standards, e.g. DO 178 or ISO 26262
35+
* Practical recommendations on how to use this piece of the language
36+
* May include considerations of "what" is being built, e.g. broadly speaking library software: (potentially broke down further into low-level driver code, a framework system for real-time applications, SDKs) vs application software
37+
* Should be done in parallel with developing an addendum matrix to reduce burden of attaching these later
38+
* We can begin with DO 178 and ISO 26262 at perhaps chapter level, maybe subsection level _for now_ and expand later
39+
* Releases of the coding guidelines are tagged and released with versions of the stable compiler which they support
40+
* Upstream Clippy lints which will cover decideable guidelines
41+
42+
## Goals obtained by discussion with Tooling Subcommittee
43+
44+
* Make a label for each which _in theory_ is decidable or not
45+
* Include for each a minimum of one compliant and non-compliant example of code to illustrate point
46+
* 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
48+
* 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)
49+
50+
# Non-goals
51+
52+
* For the initial version to be complete coverage of the Rust programming languages pieces
53+
* "Something" shipped to alleviate pressure at organizations is better than "nothing available"
54+
* For any version to be conflict-free with various members' or their organizations' viewpoints
55+
* Members and their organizations may take different stances on how pieces of the Rust programming language should be viewed and approached. This is okay and expected. We'd like to ship something that we can obtain broad consensus on and worst case scenario there may be a section here or there which you may need to adjust in an internal version that'd downstream.

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,12 @@ See [CONTRIBUTING.md](CONTRIBUTING.md).
109109

110110
We have the same chapter layout as the [Ferrocene Language Specification](https://spec.ferrocene.dev/) (FLS). If you would like to contribute you may find a section from the FLS of interest and then write a guideline in the corresponding chapter of these coding guidelines.
111111

112+
### Submit coding guideline issue
113+
114+
For a new coding guideline you'd like to contribute, start with opening a [coding guideline issue](https://github.com/rustfoundation/safety-critical-rust-coding-guidelines/issues/new?template=CODING-GUIDELINE.yml).
115+
116+
Once an issue has been well-developed enough it's then time to write up the guideline.
117+
112118
### Guideline template
113119

114120
We have a script `./generate-guideline-templates.py` which which assumes you're using `uv` that can be run to generate the template for a guideline with properly randomized IDs.

0 commit comments

Comments
 (0)