From dbb215ecf74efb847a0ff6d28fc7cc2b48c99f05 Mon Sep 17 00:00:00 2001 From: Bryan Newbold Date: Wed, 24 Jan 2018 22:44:52 -0800 Subject: restructure --- proposals/0001-dep-process.md | 25 +++++++++++-------------- 1 file changed, 11 insertions(+), 14 deletions(-) (limited to 'proposals') diff --git a/proposals/0001-dep-process.md b/proposals/0001-dep-process.md index 1983b08..de36f8f 100644 --- a/proposals/0001-dep-process.md +++ b/proposals/0001-dep-process.md @@ -53,13 +53,14 @@ protocol. The overall developent and decision making process should be more transparent, accessible, and scalable to a growing group of application developers and end users -# Submitting a Proposal + +# How To Submit a Proposal [submit]: #submit As a first step, before drafting a DEP or implementing experimental new protocol features, it's helpful to informally pitch your idea to see if others in the community are already thinking something similar, or have discussed the -same idea in the past. This discussion could happen over chat, github issues, +same idea in the past. This discussion could happen over chat, Github issues, blog posts, or other channels. If you can recruit collaborators and work out some of the details, all the better. This period could be called **pre-DEP**. @@ -109,21 +110,12 @@ new DEP is: as a new DEP. Draft, Process, and Informational DEPs have a lower bar for evolution over time via direct PR. -For appropriate DEPs (including *all* Standards DEPs), authors should -explicitly consider and note impacts on: - -* Privacy and User Rights: consider reading IETF [RFC 6973] ("Privacy - Considerations for Internet Protocols") and [RFC 8280] ("Research into Human - Rights Protocol Considerations") -* Backwards compatibility of on-disk archives and older network clients - -[RFC-6973]: https://tools.ietf.org/html/rfc6973 -[RFC-8280]: https://tools.ietf.org/html/rfc8280 - - # Details [reference-documentation]: #reference-documentation +## Types and Statuses +[types]: #types + DEPs should have a type: * **Standard** for technical changes to the protocol, on-disk formats, or @@ -154,6 +146,9 @@ The status of a DEP can be: active DEP; the new DEP should specify specific old DEPs that it would supersede. +## Content and Structure +[content]: #content + A changelog should be kept in the DEP itself giving the date of any changes of status. @@ -259,6 +254,7 @@ another" place to look. [datproto-group]: https://github.com/datprotocol [discussion-repo]: https://github.com/datproject/discussions/issues + # Background and References [references]: #references @@ -298,6 +294,7 @@ designing the DEP process: [ietf]: https://www.ietf.org/about/process-docs.html [pep-1]: https://www.python.org/dev/peps/pep-0001/ + # Unresolved questions [unresolved]: #unresolved-questions -- cgit v1.2.3