You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs(rfc): improve template and add creation skill (#1889)
Add a create-rfc skill that directs agents through the OpenShell RFC process
and template. Expand the RFC template with clearer section guidance and
suggested lengths.
Signed-off-by: Kris Hicks <khicks@nvidia.com>
description: Create OpenShell RFC proposals in rfc/ from a design request. Use when the user asks to write, draft, start, create, or update an RFC, Request for Comments, architecture proposal, API proposal, process proposal, or cross-cutting design proposal that should follow the OpenShell RFC process and template.
4
+
---
5
+
6
+
# Create RFC
7
+
8
+
## Workflow
9
+
10
+
Create RFCs by following `rfc/README.md` and `rfc/0000-template/README.md`.
11
+
Keep the template as the source of truth for section guidance.
12
+
13
+
1. Read `rfc/README.md` to confirm when an RFC is appropriate, how to choose the
14
+
RFC number, and how the lifecycle works.
15
+
2. Read `rfc/0000-template/README.md` before drafting. Follow its section
16
+
guidance, including scope, expected detail, and suggested section length.
17
+
3. Choose the next available `NNNN` from the existing `rfc/NNNN-*` directories
18
+
unless the user provided a specific number.
19
+
4. Create `rfc/NNNN-short-title/README.md` by copying the template and replacing
20
+
placeholders. Use a short hyphenated folder title.
21
+
5. Fill in front matter with the RFC author, `state: draft`, and any related
22
+
links the user provided. If the author is unknown, use the requesting user's
23
+
GitHub handle when available or leave the template placeholder.
24
+
6. Draft each section from the user's design context. Keep Summary concise,
25
+
Motivation readable by anyone, Non-goals explicit, Proposal focused on what
26
+
is being proposed, and Alternatives focused on credible competing approaches.
27
+
7. Preserve uncertainty in Open questions instead of silently deciding unknowns.
28
+
If a missing decision blocks a coherent RFC, ask the user for that decision.
29
+
8. Check the completed RFC against the template once more before finishing.
30
+
31
+
## Writing Standards
32
+
33
+
- Prefer concrete design statements over placeholder language.
34
+
- Link to relevant issues, prior RFCs, and architecture docs when they provide
35
+
needed context.
36
+
- Keep rejected or left-out designs in Alternatives, not Proposal.
37
+
- Use Mermaid diagrams for architecture or data flow when a diagram would make
38
+
the proposal easier to review.
39
+
- Do not update `architecture/` or published docs just because an RFC was
40
+
drafted. Those updates belong with implementation or with an accepted RFC when
41
+
the user asks for them.
42
+
43
+
## Validation
44
+
45
+
Before handing the RFC back to the user:
46
+
47
+
- Verify the folder name and RFC number match the process in `rfc/README.md`.
48
+
- Verify every template section is present or intentionally marked as not
49
+
applicable.
50
+
- Run a Markdown formatting or lint check only if the repo already provides one
0 commit comments