File: template.md

package info (click to toggle)
tarantool 2.6.0-1.2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 85,396 kB
  • sloc: ansic: 513,775; cpp: 69,493; sh: 25,650; python: 19,190; perl: 14,973; makefile: 4,176; yacc: 1,329; sql: 1,074; pascal: 620; ruby: 190; awk: 18; lisp: 7
file content (25 lines) | stat: -rw-r--r-- 1,091 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
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.