Skip to content

Commit

Permalink
docs: detail the RFC process (#21)
Browse files Browse the repository at this point in the history
  • Loading branch information
JoshuaLicense authored Mar 11, 2024
1 parent a1d4494 commit 8013a0b
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 13 deletions.
44 changes: 44 additions & 0 deletions docs/rfc/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Overview

This document outlines the Request For Comments (RFC) process, designed to ensure thorough consideration and team consensus on proposed changes.

## Purpose

The RFC process serves as a structured avenue for proposing, discussing, and refining alterations within this repository, fostering collaboration and informed decision-making.

## How it Works

The RFC process operates as follows:

1. **Proposal Creation**: Propose a new RFC by creating a new file named `rfc-[number]-[title]` in this directory. It is _recommended_ to use the [template](#template) below for file structure.
2. **Pull Request**: Submit the RFC via a pull request.
3. **Discussion and Iterative Refinement**: Engage in discussions and iterate on the RFC as needed using pull request comments. Allow a minimum of 7 days for open discussion and feedback on the RFC.
4. **Acceptance**: Upon consensus, merge the RFC into the repository. If the RFC is rejected, close the pull request and provide a summary of the decision.

This structured approach ensures transparency, thorough deliberation, and alignment before implementing changes.

:::info

If no objections are raised within 7 days, the RFC will be considered accepted. If objections are raised, the RFC will be revised and resubmitted for further discussion.

If no consensus is reached, the lead engineer will make the final decision.

:::

## Template

```markdown
# RFC-000: Title

## Summary

<!-- Summarise the RFC in a few sentences. -->

## Problem

<!-- What is the problem that this RFC is trying to solve? -->

## Proposal

<!-- What is the proposed solution? -->
```
13 changes: 0 additions & 13 deletions docs/rfc/rfc-000-template.md

This file was deleted.

0 comments on commit 8013a0b

Please sign in to comment.