Skip to content

docs(rfc): add RFC process with draft/review/accepted lifecycle#678

Merged
drew merged 3 commits intomainfrom
start-rfc-process
Mar 30, 2026
Merged

docs(rfc): add RFC process with draft/review/accepted lifecycle#678
drew merged 3 commits intomainfrom
start-rfc-process

Conversation

@drew
Copy link
Copy Markdown
Collaborator

@drew drew commented Mar 30, 2026

Summary

Introduces the RFC process for OpenShell. RFCs provide a structured way to propose cross-cutting changes, gather feedback, and document decisions before implementation begins.

Changes

  • Added rfc/README.md with full process documentation, state definitions, and lifecycle steps
  • Added rfc/0000-template.md as the starting point for new RFCs
  • Updated CONTRIBUTING.md to reference the RFC directory and process

RFC states

State Description
draft Being written, not yet ready for review
review Under active discussion in a PR
accepted Approved and ready for implementation
rejected Reviewed and declined
implemented Fully built out
superseded Replaced by a newer RFC

Testing

  • mise run pre-commit passes
  • Unit tests added/updated
  • E2E tests added/updated (if applicable)

Checklist

  • Follows Conventional Commits
  • Commits are signed off (DCO)
  • Architecture docs updated (if applicable)

@drew drew requested a review from a team as a code owner March 30, 2026 15:58
@drew drew self-assigned this Mar 30, 2026
johntmyers
johntmyers previously approved these changes Mar 30, 2026

### 5. Merge the pull request

After there has been time for folks to comment, the RFC author requests merge and a maintainer approves and merges. The state should be updated from `review` to `accepted`. If the proposal is declined, the state should be set to `rejected`. The timing is left to the author's discretion. As a guideline, a few business days seems reasonable, but circumstances may dictate a different timeline.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are rejected RFCs committed into the repo?


### 1. Reserve an RFC number

Look at the existing RFCs in this directory and choose the next available number. If two authors happen to pick the same number on separate branches, the conflict is resolved during PR review — the later PR simply picks the next available number.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With the amount of RFCs we will have in progress at any time this probably will work fine, maybe we could say that when choosing the number check the directory and any opened RFCs (and a link to anything tagged with "rfc" to make it easy to filter).

@drew drew merged commit c1dd81e into main Mar 30, 2026
9 checks passed
@drew drew deleted the start-rfc-process branch March 30, 2026 17:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants