Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
R
RIOT
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container Registry
Model registry
Operate
Environments
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
cm-projects
RIOT
Commits
b7991099
Commit
b7991099
authored
6 years ago
by
danpetry
Browse files
Options
Downloads
Patches
Plain Diff
doc/rdm: clarification to change process
parent
b6eb12c6
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
doc/memos/rdm0000.md
+12
-7
12 additions, 7 deletions
doc/memos/rdm0000.md
with
12 additions
and
7 deletions
doc/memos/rdm0000.md
+
12
−
7
View file @
b7991099
...
...
@@ -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.
Small changes/clarifications may be subsequently PRed to improve a memo, using
the same RDM number. 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
RDM number, deprecating the old memo. In this case, the deprecated memo must
be modified such that its status indicates "deprecated by
[
RDM XXXX
](
./rdmXXXX.md
)
"
where X is the RDM number of the new memo.
the same RDM number. These are defined as: corrections to spelling,
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.
Any other changes should result in a new memo with another RDM number,
deprecating the old memo. In this case, the deprecated memo must be modified
such that its status indicates "deprecated by
[
RDM XXXX
](
./rdmXXXX.md
)
" where X
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.
It is acceptable to add complementary content such as graphical elments
...
...
@@ -143,6 +147,7 @@ Matthias Wählisch for their comments and suggestions.
## Revision
-
Rev3: clarified allowed changes between revisions
-
Rev2: added title in metadata and specification of temporary RDM naming
-
Rev1: added text on non-compulsory nature of RDMs
-
Rev0: initial document
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment