From bcea27e30a742211072a3440cc3f72c4e4f850e7 Mon Sep 17 00:00:00 2001 From: Alex Scotton Date: Mon, 8 Aug 2022 14:47:16 +0100 Subject: [PATCH 1/2] RFC-0001: Propose a format and process for handling RFCs for Norfolk Developers Ltd. --- rfc/0001-an-rfc-schema.md | 46 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 rfc/0001-an-rfc-schema.md diff --git a/rfc/0001-an-rfc-schema.md b/rfc/0001-an-rfc-schema.md new file mode 100644 index 0000000..78e6d95 --- /dev/null +++ b/rfc/0001-an-rfc-schema.md @@ -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). +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: +--- +``` + +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" \ No newline at end of file From b34a6f81895117b8aedf6fdbc20620b80e1ca2f5 Mon Sep 17 00:00:00 2001 From: Alex Scotton Date: Mon, 5 Sep 2022 11:50:26 +0100 Subject: [PATCH 2/2] RFC-0001: Adds a template RFC --- RFC.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 RFC.md diff --git a/RFC.md b/RFC.md new file mode 100644 index 0000000..cab4a78 --- /dev/null +++ b/RFC.md @@ -0,0 +1,29 @@ +--- +title: An RFC +date: "YYYY-MM-DD" +author: An Author +type: +--- + +# 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. \ No newline at end of file