Skip to content

Commit 5ea454b

Browse files
authored
ci: add website-scoped typo checks (Safety-Critical-Rust-Consortium#566)
* ci: add website-scoped typos check workflow * chore: add baseline typos config * fix(docs): correct typo in mission heading * docs: add local typo check command * test(ci): add intentional typo to validate typos check * Revert "test(ci): add intentional typo to validate typos check" This reverts commit cd360fe.
1 parent c78ada6 commit 5ea454b

4 files changed

Lines changed: 41 additions & 2 deletions

File tree

.github/workflows/check-typos.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: Check typos
2+
3+
permissions:
4+
contents: read
5+
6+
on:
7+
pull_request:
8+
push:
9+
branches:
10+
- main
11+
merge_group:
12+
13+
jobs:
14+
check_typos:
15+
name: check_typos
16+
runs-on: ubuntu-latest
17+
steps:
18+
- name: Checkout repository
19+
uses: actions/checkout@v4
20+
21+
- name: Check for typos
22+
uses: crate-ci/typos@v1.40.0
23+
with:
24+
files: ./arewesafetycriticalyet.org

CONTRIBUTING.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,5 +30,14 @@ for more information on using pull requests.
3030
Do you just want to file an issue for the project? Please do so in GitHub under
3131
the `Issues` tab.
3232

33+
### Local checks
34+
35+
For changes under the website directory, you can run typo checks locally before
36+
pushing:
37+
38+
```shell
39+
typos arewesafetycriticalyet.org
40+
```
41+
3342
[ip-policy]: https://foundation.rust-lang.org/policies/intellectual-property-policy/
3443
[pull-requests]: https://help.github.com/articles/about-pull-requests/

_typos.toml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Project typo configuration for CI.
2+
# Keep allowlists narrow and add entries only for verified false positives.
3+
4+
[default]
5+
extend-ignore-identifiers-re = []
6+
7+
[default.extend-words]

arewesafetycriticalyet.org/docs/coding_guidelines/mission.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ An effort led out of the [AUTOSAR Foundation](https://www.autosar.org/) titled t
2222
2323
An outcome of this working group is the [Explanation of ARA Applications in Rust](https://www.autosar.org/fileadmin/standards/R23-11/AP/AUTOSAR_AP_EXP_ARARustApplications.pdf) document which outlines the API which can be used to write Rust applications within an Adaptive AUTOSAR environment.
2424

25-
## Other Safety-Critial Guidelines
25+
## Other Safety-Critical Guidelines
2626

2727
### MISRA C, C++
2828

@@ -35,4 +35,3 @@ There was an [effort](https://github.com/PolySync/misra-rust/blob/master/MISRA-R
3535
We would like to put out a request for those that have used Rust in safety-critical applications, may be familiar with `unsafe` best practices, or otherwise feel they have guidelines or experience to contribute to please reach out to us!
3636

3737
As we adopt pieces of these documents we can keep track of contribution provenance here.
38-

0 commit comments

Comments
 (0)