summaryrefslogtreecommitdiffstats
path: root/template.rst
diff options
context:
space:
mode:
authorEdward Welbourne <edward.welbourne@qt.io>2018-04-17 11:35:02 +0200
committerLars Knoll <lars.knoll@qt.io>2018-05-23 12:59:55 +0000
commitbd52f6ac01c3c4c4548061a50747f04c5e690a7c (patch)
tree5c1c86cc7e4cf124182748b944f554ee73dcd084 /template.rst
parentf92ce52537dace6c27aea83ef0aa1b45bba7afa5 (diff)
Prune the QUIP life-cycle and add a QUIP template
The template.rst will make it easier for future QUIP authors to get started. In the course of review of it, we decided that QUIP-1 offered too many options for Status: it was based on the PEP life-cycle where we have settled on a simpler life-cycle for QUIPs. So pruned the list of Status options and made references to the PEP system explicit by providing links. Change-Id: I838163e4e830e263d38c6ad63a685735593d6112 Reviewed-by: Kai Koehne <kai.koehne@qt.io> Reviewed-by: Frederik Gladhorn <frederik.gladhorn@qt.io> Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@qt.io> Reviewed-by: Lars Knoll <lars.knoll@qt.io>
Diffstat (limited to 'template.rst')
-rw-r--r--template.rst32
1 files changed, 32 insertions, 0 deletions
diff --git a/template.rst b/template.rst
new file mode 100644
index 0000000..3ee821a
--- /dev/null
+++ b/template.rst
@@ -0,0 +1,32 @@
+QUIP:
+Title:
+Author: Comma-Separated List,
+ With Continuation Lines
+Status: { Active | Superseded | Withdrawn }
+Type: { Implementation | Informational | Process }
+[Qt-Version:]
+[Content-Type: text/x-rst]
+[Requires: QUIP-1]
+Created: YYYY-MM-dd
+Post-History: http://lists.qt-project.org/pipermail/development/YYYY-Month/nnnnnn.html
+[Replaces:]
+[Superseded-By:]
+
+Title
+=====
+
+Introductory paragraph, motivation.
+Use reStructuredText_ mark-up.
+
+Various sections
+----------------
+
+Develop the theme and state the proposal.
+
+References
+----------
+
+.. [0] QUIP-1 defines the form this template anticipates:
+ https://code.qt.io/cgit/meta/quips.git/tree/quip-0001.rst
+
+.. _reStructuredText: http://docutils.sourceforge.net/rst.html