Skip to content

Commit caf7ddb

Browse files
committed
docs(readme): add roadmap and RFC issue guidance
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
1 parent 8d83776 commit caf7ddb

3 files changed

Lines changed: 8 additions & 7 deletions

File tree

‎README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -234,6 +234,7 @@ All implementation work is human-gated — agents propose plans, humans approve,
234234
- [Quickstart](https://docs.nvidia.com/openshell/latest/get-started/quickstart) — detailed install and first sandbox walkthrough
235235
- [GitHub Sandbox Tutorial](https://docs.nvidia.com/openshell/latest/tutorials/github-sandbox) — end-to-end scoped GitHub repo access
236236
- [Architecture](https://github.com/NVIDIA/OpenShell/tree/main/architecture) — detailed architecture docs and design decisions
237+
- [Roadmap](https://github.com/orgs/NVIDIA/projects/233) — planned work and project priorities
237238
- [Support Matrix](https://docs.nvidia.com/openshell/latest/reference/support-matrix) — platforms, versions, and kernel requirements
238239
- [Brev Launchable](https://brev.nvidia.com/launchable/deploy/now?launchableID=env-3Ap3tL55zq4a8kew1AuW0FpSLsg) — try OpenShell on cloud compute without local setup
239240
- [Agent Instructions](AGENTS.md) — system prompt and workflow documentation for agent contributors

‎rfc/0000-template/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ authors:
33
- "@your-github-username"
44
state: draft
55
links:
6-
- (related PRs, discussions, or issues)
6+
- (related PRs or issues)
77
---
88

99
# RFC NNNN - Your Title Here

‎rfc/README.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,24 @@
22

33
Substantial changes to OpenShell should be proposed in writing before implementation begins. An RFC provides a consistent way to propose an idea, collect feedback from the community, build consensus, and document the decision for future contributors. Not every change needs an RFC — bug fixes, small features, and routine maintenance go through normal pull requests. RFCs are for the changes that are cross-cutting, potentially controversial, or significant enough that stakeholders should weigh in before code is written.
44

5-
## Start with a GitHub Discussion
5+
## Start with a GitHub issue
66

7-
Before writing an RFC, consider opening a [GitHub Discussion](https://github.com/NVIDIA/OpenShell/discussions) to gauge interest and get early feedback. This helps:
7+
Before writing an RFC, consider opening a [GitHub issue](https://github.com/NVIDIA/OpenShell/issues/new/choose) to scope the problem, gauge interest, and get early feedback. This helps:
88

99
- Validate that the problem is worth solving
1010
- Surface potential concerns early
1111
- Build consensus before investing in a detailed proposal
1212
- Identify the right reviewers and stakeholders
1313

14-
If the discussion shows sufficient interest and the idea has merit, then it's time to write an RFC to detail the plan and technical approach.
14+
If the ticket shows sufficient interest and the idea has merit, then it's time to write an RFC to detail the plan and technical approach.
1515

1616
## RFCs vs other artifacts
1717

1818
OpenShell has several places where design information lives. Use this guide to pick the right one:
1919

2020
| Artifact | Purpose | When to use |
2121
|----------|---------|-------------|
22-
| **GitHub Discussion** | Gauge interest in a rough idea | You have a thought but aren't sure it's worth a proposal yet |
22+
| **GitHub issue** | Track and scope a rough idea | You have a thought but aren't sure it's worth a proposal yet |
2323
| **Spike issue** (`create-spike`) | Investigate implementation feasibility for a scoped change | You need to explore the codebase and produce a buildable issue for a specific component or feature |
2424
| **RFC** | Propose a cross-cutting decision that needs broad consensus | Architectural changes, API contracts, process changes, or anything that spans multiple components or teams |
2525
| **Architecture doc** (`architecture/`) | Document how things work today | Living reference material — updated as the system evolves |
@@ -61,15 +61,15 @@ authors:
6161
state: draft
6262
links:
6363
- https://github.com/NVIDIA/OpenShell/pull/123
64-
- https://github.com/NVIDIA/OpenShell/discussions/456
64+
- https://github.com/NVIDIA/OpenShell/issues/456
6565
---
6666
```
6767

6868
We track the following metadata:
6969

7070
- **authors**: The authors (and therefore owners) of an RFC. Listed as GitHub usernames.
7171
- **state**: Must be one of the states discussed below.
72-
- **links**: Related PRs, discussions, or issues. Add entries as the RFC progresses.
72+
- **links**: Related PRs or issues. Add entries as the RFC progresses.
7373
- **superseded_by**: *(optional)* For RFCs in the `superseded` state, the RFC number that replaces this one (e.g., `0005`).
7474

7575
An RFC can be in one of the following states:

0 commit comments

Comments
 (0)