Skip to content

Commit c91355e

Browse files
authored
add coding guidelines notes 2026-01-27 (Safety-Critical-Rust-Consortium#558)
1 parent da53740 commit c91355e

1 file changed

Lines changed: 89 additions & 0 deletions

File tree

  • subcommittee/coding-guidelines/meetings/2026-01-27
Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
# **Coding Guidelines Subcommittee Meeting on 2026-01-27 @ 20:00 EST / 2026-01-28 @ 10:00 JST**
2+
3+
[Link](https://www.worldtimebuddy.com/?qm=1&lid=2643743,12,8,5,1850147&h=5&date=2026-1-27&sln=20-21&hf=1) to meeting time in common time zones.
4+
5+
| Search Key | Description |
6+
| :---- | :---- |
7+
| \[todo\] | Action Item |
8+
| \[decision\] | Something decided on |
9+
| \[important\] | Key information |
10+
11+
## **Agenda**
12+
13+
1. Solicitation of notetaker
14+
2. Acceptance of [Previous Meeting Minutes](../2025-12-17/minutes.md)
15+
3. Introduction of new members
16+
4. `@guidelines-bot` and its use (Félix)
17+
* Helps fairly distribute reviews in round-robin fashion to Producers
18+
* Other abilities too, leave a comment as @guidelines-bot /commands to see what's possible
19+
5. Tags for coding guidelines (Félix)
20+
* [Tags List for Safety Critical Guidelines](https://docs.google.com/spreadsheets/d/1SPhThaQhJOTvMyuyq8Buu-OVZ2D1CiosofrUmOGONqk/edit?gid=0#gid=0)
21+
6. [CERT C \=\> Rust Mapping](http://github.com/rustfoundation/safety-critical-rust-coding-guidelines/issues/336) (Félix)
22+
* Some [open questions](https://github.com/rustfoundation/safety-critical-rust-coding-guidelines/issues/336#issuecomment-3678192763)
23+
7. Round table
24+
25+
## **Check-in area**
26+
27+
* Félix Fischer 🙂
28+
* Pete LeVasseur 🖖
29+
* Matthew Butler
30+
* Max Jacinto 🫠
31+
32+
**Please add your name, and an emoji that describes your day.**
33+
34+
**Notetaker:**
35+
36+
* Pete LeVasseur
37+
38+
For tips on how we take notes in the Safety-Critical Rust Consortium, please see the [Meeting Notetaker Role](https://github.com/rustfoundation/safety-critical-rust-consortium/blob/main/docs/notetaker-role.md) doc.
39+
40+
## **Housekeeping section**
41+
42+
* Document space: [coding-guidelines](https://github.com/rustfoundation/safety-critical-rust-consortium/tree/main/subcommittee/coding-guidelines)
43+
* Zulip: [safety-critical-consortium: Coding Guidelines](https://rust-lang.zulipchat.com/#narrow/channel/445688-safety-critical-consortium/topic/Coding.20Guidelines)
44+
* [Kanban board](https://github.com/orgs/rustfoundation/projects/1/views/3)
45+
* [`contributor experience`](https://github.com/orgs/rustfoundation/projects/1/views/4) view
46+
* [`coding guideline`](https://github.com/orgs/rustfoundation/projects/1/views/5) view
47+
48+
## **Tasks**
49+
50+
* xx
51+
52+
## **Meeting Minutes**
53+
54+
* `@guidelines-bot` and its use
55+
* Showcase of how to create a Coding Guideline via the [issue template](https://github.com/rustfoundation/safety-critical-rust-coding-guidelines/issues/new?template=CODING-GUIDELINE.yml)
56+
* Helps manage reviews (assignment, in round-robin)
57+
* Helps check for completeness of code examples, e.g. whether compiles when expected
58+
* Helps convert from Markdown to the reStructuredText (rST) format used in the guideline text
59+
* Bot detects and makes note of any warnings or errors
60+
* Bit of dialogue with the bot until all passing
61+
* Some bot-commands are known issues, there have been issues opened to resolve it
62+
* **\[todo: PLeVasseur\]**: Command to @guidelines-bot to approve directly
63+
* Then can take the generated reStructuredText and copy \+ paste it into a new file in the correct location. Bot informs on how to do it.
64+
* Example issue, example PR
65+
* **\[todo: PLeVasseur\]**: Last-minute Final Comment Period (FCP) of \~10 days before merge, perhaps?
66+
* Could we have a way to have a scale of complexity, maybe improved tags to help people pick up issues to work on coding guidelines?
67+
* Seems challenging, since people’s experience and their familiarity may be not very easy to categorize
68+
* [CERT C \=\> Rust Mapping](http://github.com/rustfoundation/safety-critical-rust-coding-guidelines/issues/336)
69+
* Bite-sized pieces of CERT C categorized to allow for picking up and writing coding guidelines
70+
* Making good progress of shrinking the “Unknown to me” table through help and support from others
71+
* Some categorizations, with a call for help
72+
* [List of rules that DO NOT map to Rust, and why](https://github.com/rustfoundation/safety-critical-rust-coding-guidelines/issues/336#issuecomment-3677559154)
73+
* [List of rules that DEFINITELY map to Rust, and how](https://github.com/rustfoundation/safety-critical-rust-coding-guidelines/issues/336#issuecomment-3678206011)
74+
* [Rules that map to Unsafe Rust, and how / why](https://github.com/rustfoundation/safety-critical-rust-coding-guidelines/issues/336#issuecomment-3678212946)
75+
* [WIP (Félix)](https://github.com/rustfoundation/safety-critical-rust-coding-guidelines/issues/336#issuecomment-3678187509): I'm actively working out if / how they map to Rust
76+
* [Unknown to me](https://github.com/rustfoundation/safety-critical-rust-coding-guidelines/issues/336#issuecomment-3678192763): **please help me fill those\!**
77+
* Tags for coding guidelines
78+
* [Tags List for Safety Critical Guidelines](https://docs.google.com/spreadsheets/d/1SPhThaQhJOTvMyuyq8Buu-OVZ2D1CiosofrUmOGONqk/edit?gid=0#gid=0)
79+
* Currently comma-separated value list in the Coding Guideline issue template
80+
* Will fail the build if tag you use doesn’t currently exist in the `conf.py` listing of tags
81+
* Idea is to crowd-source tags to allow for a cohesive set to be gathered
82+
* **\[todo: PLeVasseur\]**: Can we make tags selectable, e.g. by multiple selections to make this easier on the Coding Guideline issue template?
83+
84+
## **Material**
85+
86+
Any material to read before the meeting should be included here.
87+
88+
* Milestone: [Prepare for launch to wider Rust community](https://github.com/rustfoundation/safety-critical-rust-coding-guidelines/milestone/1)
89+

0 commit comments

Comments
 (0)