Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RFC-0001: Propose a format and process for handling RFCs #2

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions RFC.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: An RFC
date: "YYYY-MM-DD"
author: An Author
type: <Organisation|Discord>
---

# Summary

A short introduction to the intentions of the RFC

If someone only reads this far, what do you want them to know?

# Goal

What problems are you trying to solve? What problems are you not trying to solve?

# Background & Motivation

What is the current state or process? Why is this change being proposed?

# Resolution

Describe the proposed solution to the achieve the goal.

Where relevant this RFC should be submitted with the relevant changes to
supporting documentation or configuration, e.g. if the resolution is related to
Discord, then it's [configuration file](./discord/config.yml) should also be
updated.
46 changes: 46 additions & 0 deletions rfc/0001-an-rfc-schema.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
title: An RFC Schema
date: "2022-08-05"
author: Alex Scotton
type: Organisation
---

# Summary

Introduce a schema and process for handling RFCs within the community.

# Schema

This document represents the schema for a nor(DEV): RFC in some strange
self-propagating nature.

Updates to the schema will occur in subsequent RFCs if and when required.
An example of the current schema is [at the root of this repository](../RFC.md).
Illizian marked this conversation as resolved.
Show resolved Hide resolved
The document should then be referred to when proposing a new RFC.

[YAML front matter](https://assemble.io/docs/YAML-front-matter.html) should be
used to provide metadata for the RFC. The body of the RFC is currently open to
the author's discretion but should be used to explain the change desired.

```yml
---
title: An RFC
date: "2022-08-05"
author: An Author
type: <Organisation|Discord>
---
```

If the RFC proposal includes updates to features already tracked within this
repository, then the [Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)
should also include these changes when relevant or possible.

# Process

The process for accepting and implementing RFCs is:

1. Create Pull Request (or remove the draft status from the PR)
2. RFC is open for discussion
3. The RFC is merged and applied given:
- All (upto a max of 5) colloborators have approved
4. The RFC is applied by the admin team and "merged"