Skip to content
Snippets Groups Projects
Verified Commit 3ad82f53 authored by Christian Heusel's avatar Christian Heusel :rocket:
Browse files

Merge branch 'feat/convert-rfc-template-to-md' into 'master'

feat: Convert restructuredtext based template to markdown

See merge request !44
parents 575240ba 4e1be373
No related branches found
No related tags found
No related merge requests found
Pipeline #111924 passed
......@@ -85,7 +85,7 @@ Fork this repository if you have not already.
Step 2: Write RFC
_________________
Copy **rfcs/0000-template.rst** to **rfcs/0000-<my-proposal-title>.rst** and begin
Copy **rfcs/0000-template.md** to **rfcs/0000-<my-proposal-title>.md** and begin
working on the RFC.
Please put a lot of thought into your writing. A great RFC explains and
......@@ -109,8 +109,8 @@ comments of the merge request.
After the merge request is created, the merge request number (e.g. 42) is your RFC
number. Then do the following:
1. In the branch, rename the file from **rfcs/0000-<my-proposal-title>.rst** to
**rfcs/0042-<my-proposal-title>.rst**. This makes all the proposals show up
1. In the branch, rename the file from **rfcs/0000-<my-proposal-title>.md** to
**rfcs/0042-<my-proposal-title>.md**. This makes all the proposals show up
in ascending chronological order when someone visits the `rfcs <rfcs/>`_
directory.
2. In the file itself, there is a bullet point labeled **RFC MR:**. Update this
......
......@@ -3,53 +3,42 @@ title: "Template"
draft: true
---
=====
Title
=====
# Title
- Date proposed: yyyy-mm-dd
- RFC MR: https://gitlab.archlinux.org/archlinux/rfcs/-/merge_requests/0000
**update this number after RFC merge request has been filed**
Summary
-------
## Summary
Short description, 1-2 sentences.
Motivation
----------
## Motivation
Introduce the topic. If this is a not-well-known section of Arch Linux, a
detailed explanation of the background is recommended.
Introduce the topic.
If this is a not-well-known section of Arch Linux, a detailed explanation of the background is recommended.
Some example points of discussion:
- What specific problems are you facing right now that you're trying to address?
- Are there any previous discussions? Link to them and summarize them (don't
force your readers to read them though!).
- Are there any previous discussions? Link to them and summarize them (don't force your readers to read them though!).
- Is there any precedent set by other software? If so, link to resources.
Specification
-------------
## Specification
A concrete, thorough explanation of what is being planned.
Drawbacks
---------
## Drawbacks
Carefully consider every possible objection and issue with your proposal. This
section should be updated as feedback comes in from discussion.
Carefully consider every possible objection and issue with your proposal.
This section should be updated as feedback comes in from discussion.
Unresolved Questions
--------------------
## Unresolved Questions
Are there any portions of your proposal which need to be discussed with the
community before the RFC can proceed? Be careful here -- an RFC with a lot of
remaining questions is likely to be stalled. If your RFC is mostly unresolved
questions and not too much substance, it may not be ready.
Are there any portions of your proposal which need to be discussed with the community before the RFC can proceed?
Be careful here -- an RFC with a lot of remaining questions is likely to be stalled.
If your RFC is mostly unresolved questions and not too much substance, it may not be ready.
Alternatives Considered
-----------------------
## Alternatives Considered
A list of alternatives, that have been considered and offer equal or similar
features to the proposed change.
A list of alternatives, that have been considered and offer equal or similar features to the proposed change.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment