Skip to content

Latest commit

 

History

History
58 lines (52 loc) · 2.17 KB

contribute.org

File metadata and controls

58 lines (52 loc) · 2.17 KB

How to contribute to this project

How to contribute to this project

In order to prevent conflicts both of personalities and version control, please follow these guidelines.

  1. clone this repo,
  2. make a branch if changes will be extensive,
  3. make edits,
  4. add your name to the authors list if you haven’t already, and
  5. submit a pull request!

Proposing an RFC

Language features will be added or modified on the basis of Request For Comment documents. The resources below will help you familiarize yourself with this format.

How to write an RFC
a guide to writing RFC documents,
RFC Guidelines
we won’t use this exact format, but it’s a good guideline,
Key Words
covers use and inrerpretation of terms like, “MUST”, “MUST NOT”, “RECOMMENDED”, etc.

RFC Template

Copy and rename this document, changing and adding content as needed. Save your RFC in drafts and make a PR.

#+title: RFC: title
#+author: author name or handle
* Problem
Factual description of the problems solved by the RFC.
* Duration
Time window in whcih the RFC is open for comment. If the deadline is
reached and more time is needed, make a note of the extension and the
new deadline below. For example:

[2020-07-01 Wed] (extended by @porpoiseless)

[2020-08-01 Sat]
* Current State
The status of the RFC as a draft, open for comment, closed, and so on.
* Proposers
A bulleted list people endorsing this RFC.
- @me
- @you
- @someone
* Detail
Additional information about the issues prompting the RFC.
* Proposal
Thorough and systematic description of how the problem can be solved,
including tables, code listings, subsections, and so on.
* Record of votes
| Vote | Name          |
|------+---------------|
|   +1 | @porpoiseless |
* Resolution
Indicate whether RFC is a draft, awaiting approval, approved, denied,
or shelved.
* CC
A list of persons to CC about this RFC.