riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc/rdm: clarification to change process

Browse Source
This commit is contained in:
danpetry 2019-01-17 11:53:37 +01:00
parent b6eb12c6d4
commit b79910995d
1 changed files with 11 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
doc/memos/rdm0000.md
View File

@ -108,13 +108,17 @@ its status is changed to "active" and it is merged in the master branch of RIOT.
Once merged into the master branch of RIOT, a memo is considered published. Once merged into the master branch of RIOT, a memo is considered published.
Small changes/clarifications may be subsequently PRed to improve a memo, using Small changes/clarifications may be subsequently PRed to improve a memo, using
the same RDM number. In this case, a (monotonically increasing) revision number the same RDM number. These are defined as: corrections to spelling,
is issued and a changelog is added -- see Revision section in postamble below. punctuation, or grammar; clarifications to individual phrases or diagrams
without changing the intended meaning. In this case, a (monotonically
increasing) revision number is issued and a changelog is added -- see Revision
section in postamble below.
Bigger changes should result in a new memo with another Any other changes should result in a new memo with another RDM number,
RDM number, deprecating the old memo. In this case, the deprecated memo must deprecating the old memo. In this case, the deprecated memo must be modified
be modified such that its status indicates "deprecated by [RDM XXXX](./rdmXXXX.md)" such that its status indicates "deprecated by [RDM XXXX](./rdmXXXX.md)" where X
where X is the RDM number of the new memo. is the RDM number of the new memo. Note that a memo should not be published if
there are expected changes, whether small or large.
A dedicated directory in RIOT codebase (RIOT/doc/memos) contains all the memos. A dedicated directory in RIOT codebase (RIOT/doc/memos) contains all the memos.
It is acceptable to add complementary content such as graphical elments It is acceptable to add complementary content such as graphical elments
@ -143,6 +147,7 @@ Matthias Wählisch for their comments and suggestions.
## Revision ## Revision
- Rev3: clarified allowed changes between revisions
- Rev2: added title in metadata and specification of temporary RDM naming - Rev2: added title in metadata and specification of temporary RDM naming
- Rev1: added text on non-compulsory nature of RDMs - Rev1: added text on non-compulsory nature of RDMs
- Rev0: initial document - Rev0: initial document