[tor-commits] [torspec/master] Add a pair of templates for markdown proposal indices

[nickm at torproject.org]

commit 3395172250079bd0c9f20936037b3f9c2c23cc4d
Author: Nick Mathewson <nickm at torproject.org>
Date:   Mon Jul 27 10:14:24 2020 -0400

    Add a pair of templates for markdown proposal indices
---
 proposals/INDEX_template.md  | 10 +++++
 proposals/README_template.md | 99 ++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 109 insertions(+)

diff --git a/proposals/INDEX_template.md b/proposals/INDEX_template.md
new file mode 100644
index 0000000..48c457c
--- /dev/null
+++ b/proposals/INDEX_template.md
@@ -0,0 +1,10 @@
+# Tor proposals by number
+
+Here we have a set of proposals for changes to the Tor protocol.  Some
+of these proposals are implemented; some are works in progress; and some
+will never be implemented.
+
+Below are a list of proposals sorted by status.  See
+[README.md](/proposals/README.md) for a list of proposals sorted by number.
+
+{BY_INDEX}
diff --git a/proposals/README_template.md b/proposals/README_template.md
new file mode 100644
index 0000000..b8fa7e2
--- /dev/null
+++ b/proposals/README_template.md
@@ -0,0 +1,99 @@
+# Tor proposals by status
+
+Here we have a set of proposals for changes to the Tor protocol.  Some
+of these proposals are implemented; some are works in progress; and some
+will never be implemented.
+
+Below are a list of proposals sorted by status.  See
+[INDEX.md](/proposals/INDEX.md) for a list of proposals sorted by number.
+
+# Active proposals by status
+
+## OPEN proposals: Under discussion
+
+These are proposals that we think are likely to be complete, and ripe
+for discussion.
+
+{OPEN}
+
+## ACCEPTED proposals: Slated for implementation
+
+These are the proposals that we agree we'd like to implement.  They
+might or might not have a specific timeframe planned for their
+implementation.
+
+{ACCEPTED}
+
+## FINISHED proposals: Implemented, specs not merged
+
+These proposals are implemented in some version of Tor; the proposals
+themselves still need to be merged into the specifications proper.
+
+{FINISHED}
+
+## META proposals: About the proposal process
+
+These proposals describe ongoing policies and changes to the proposals
+process.
+
+{META}
+
+## INFORMATIONAL proposals: not actually specifications
+
+These proposals describe a process or project, but aren't actually
+proposed changes in the Tor specifications.
+
+{INFORMATIONAL}
+
+# Preliminary proposals
+
+## DRAFT proposals: incomplete works
+
+{DRAFT}
+
+## NEEDS-REVISION proposals: good ideas that we can't implement as-is.
+
+{NEEDS-REVISION}
+
+## NEEDS-RESEARCH proposals: blocking on research
+
+{NEEDS-RESEARCH}
+
+# Inactive proposals by status
+
+## CLOSED proposals: Implemented and specified
+
+These proposals have been implemented in some version of Tor, and the
+changes from the proposals have been merged into the specifications as
+necessary.
+
+{CLOSED}
+
+## RESERVE proposals: Saving for later
+
+These proposals aren't anything we plan to implement soon, but for one
+reason or another we think they might be a good idea in the
+future. We're keeping them around as a reference in case we someday
+confront the problems that they try to solve.
+
+{RESERVE}
+
+## SUPERSEDED proposals: Replaced by something else
+
+These proposals were obsoleted by a later proposal before they were
+implemented.
+
+{SUPERSEDED}
+
+## DEAD, REJECTED, OBSOLETE proposals: Not in our plans.
+
+These proposals are not on-track for discussion or
+implementation. Either discussion has stalled out (the proposal is
+DEAD), the proposal has been considered and not adopted (the proposal is
+REJECTED), or the proposal addresses an issue or a solution that is no
+longer relevant (the proposal is OBSOLETE).
+
+{DEAD_REJECTED_OBSOLETE}
+
+
+