Skip to content

Commit 3d8a5bd

Browse files
authored
Merge pull request #21730 from LasseRosenow/guides-replace-screenshots-with-code
doc/guides: improve guides and many small fixes
2 parents db7a67b + f5b8144 commit 3d8a5bd

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+1093
-651
lines changed

CODE_OF_CONDUCT.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,12 @@ We rather would like you to think of it as a guide to enrich our community and
1515
the technical community in general with new knowledge and perspectives by
1616
allowing everyone to participate.
1717

18-
This code of conduct applies to all spaces managed by the RIOT community. This
18+
This Code of Conduct applies to all spaces managed by the RIOT community. This
1919
includes any communication within the RIOT community, both online and face to
2020
face. In addition, violations of this code outside these spaces may also
2121
affect a person's ability to participate within them.
2222

23-
If you believe someone is violating the code of conduct, we ask that you report
23+
If you believe someone is violating the Code of Conduct, we ask that you report
2424
it by emailing <[email protected]>. For more details please see our [Reporting
2525
Guidelines][reporting-guidelines].
2626

CODING_CONVENTIONS_C++.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
1-
You should check out the [C Conventions](CODING_CONVENTIONS.md) as some section
1+
# Coding Conventions C++
2+
3+
You should check out the [C Conventions] as some section
24
still apply (Documentation, Git, Travis).
35

46
When contributing source code, please adhere to the following coding style,
57
which is loosely based on the [Google C++ Style Guide] and the coding
68
conventions used by the C++ Standard Library. Based on the [CAF coding style].
79

8-
[Google C++ Style Guide]: (https://google.github.io/styleguide/cppguide.html)
9-
[CAF coding style]: (https://github.com/actor-framework/actor-framework/blob/master/CONTRIBUTING.md)
10+
[C Conventions]: https://guide.riot-os.org/c_tutorials/coding_conventions/
11+
[Google C++ Style Guide]: https://google.github.io/styleguide/cppguide.html
12+
[CAF coding style]: https://github.com/actor-framework/actor-framework/blob/master/CONTRIBUTING.md
1013

1114
## Example for the Impatient
1215

@@ -233,7 +236,6 @@ void my_class::do_something_else() {
233236
}
234237
```
235238
236-
237239
## Headers
238240
239241
- Each `.cpp` file has an associated `.hpp` file.
@@ -258,7 +260,6 @@ void my_class::do_something_else() {
258260
259261
- Use `inline` for small functions (rule of thumb: 10 lines or less).
260262
261-
262263
## Breaking Statements
263264
264265
- Break constructor initializers after the comma, use four spaces for
@@ -295,7 +296,6 @@ void my_class::do_something_else() {
295296
}
296297
```
297298

298-
299299
## Template Metaprogramming
300300

301301
Despite its power, template metaprogramming came to the language pretty
@@ -340,15 +340,13 @@ extra rules for formatting metaprogramming code.
340340
ResponseHandleTag>;
341341
```
342342

343-
344343
## Preprocessor Macros
345344

346345
- Use macros if and only if you can't get the same result by using inline
347346
functions or proper constants.
348347

349348
- Macro names use the form `RIOT_<COMPONENT>_<NAME>`.
350349

351-
352350
## Comments
353351

354352
- Doxygen comments start with `///`.

GOVERNANCE.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -257,9 +257,9 @@ Computing Foundation (CNCF).
257257
[contributing guidelines]: https://github.com/RIOT-OS/RIOT/blob/master/CONTRIBUTING.md
258258
[maintainers list]: https://riot-os.org/maintainers.html
259259
[maintainers GitHub team]: https://github.com/orgs/RIOT-OS/teams/maintainers
260-
[managing a release]: https://github.com/RIOT-OS/RIOT/blob/master/doc/guides/managing-a-release/README.md
260+
[managing a release]: https://guide.riot-os.org/misc/managing-a-release/
261261
[maintaining guidelines]: https://github.com/RIOT-OS/RIOT/blob/master/MAINTAINING.md
262-
[Code of Conduct]: https://github.com/RIOT-OS/RIOT/blob/master/CODE_OF_CONDUCT.md
263-
[Code of Conduct reporting guidance]: https://doc.riot-os.org/coc-reporting-guide.html
262+
[Code of Conduct]: https://guide.riot-os.org/general/code_of_conduct/
263+
[Code of Conduct reporting guidance]: https://guide.riot-os.org/general/code_of_conduct/reporting/
264264
[security policy]: https://github.com/RIOT-OS/RIOT/blob/master/SECURITY.md
265265
[GOVERNANCE-maintainer.md template]: https://github.com/cncf/project-template/blob/main/GOVERNANCE-maintainer.md

0 commit comments

Comments
 (0)