From 51411a7aadac982f40bd7915c6485968a94b4082 Mon Sep 17 00:00:00 2001 From: Konstantin Osipov <kostja@tarantool.org> Date: Fri, 6 Apr 2018 10:27:45 +0300 Subject: [PATCH] rfc: add rfc template Introducing a formal, trackable process for server enhancement. Before working on a complex feature, please write an RFC document, describing what and how you see changed, and get it approved. All historical RFCs are kept in doc/rfc. --- doc/rfc/template.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 doc/rfc/template.md diff --git a/doc/rfc/template.md b/doc/rfc/template.md new file mode 100644 index 0000000000..6f09d660e1 --- /dev/null +++ b/doc/rfc/template.md @@ -0,0 +1,25 @@ +# RFC Template + +* **Status**: In progress/Complete/Deprecated +* **Start date**: DD-MM-YYYY +* **Authors**: \<Name and Last name\> @\<Github login\> \<email inside \<\>\>, \<other authors\> +* **Issues**: \[#<issue_number>\](https://github.com/tarantool/<repository\>/issues/<issue_number>), other issues ... + +## Summary + +When making a copy of the template, prefix the file name with issue number, +for example: 2677-box-session-push.md. + +Short description what, why and how is implemented. + +## Background and motivation + +A detailed description of why a described thing is needed, who needs it, and a high-level explanation of a subject (proposed feature, optimization or a complex bugfix). The description must be easy-to-understand both for a technical writer and for a developer seeing the subject in a first time. + +## Detailed design + +A low-level extremely detailed design of an implementation. It can contain ASCII diagrams, links to a code, mathematics. + +## Rationale and alternatives + +Here existing alternatives are described, and why they appeared to be worse than an implemented thing. -- GitLab