Skip to content

CODING_CONVENTIONS: Add more Info about Comment Styles #21831

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Oct 30, 2025
Merged

CODING_CONVENTIONS: Add more Info about Comment Styles #21831

merged 1 commit into from
Oct 30, 2025
+19 −0

Conversation

@crasbe
Copy link
Contributor

@crasbe crasbe commented Oct 30, 2025

Contribution description

Inspired by @miri64 s comment about comment-styles (#21827 (comment)), I took the opportunity to add this requirement/information to our Coding Conventions.

Testing procedure

Look that the Markdown Rendering looks good.

Issues/PRs references

Inspired by #21827 (comment) .

@crasbe crasbe requested a review from miri64 October 30, 2025 10:54
@crasbe crasbe requested a review from jia200x as a code owner October 30, 2025 10:54
@crasbe crasbe added Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation Impact: minor The PR is small in size and might only require a quick look of a knowledgeable reviewer CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs labels Oct 30, 2025
@github-actions github-actions bot added the Area: doc Area: Documentation label Oct 30, 2025
mguetschow
mguetschow reviewed Oct 30, 2025
View reviewed changes
@riot-ci
Copy link

riot-ci commented Oct 30, 2025 •
edited
Loading

Murdock results

✔️ PASSED

a1ccbab CODING_CONVENTIONS: add more info about comment styles

Success Failures Total Runtime
1 0 1 01m:49s

Artifacts

mguetschow
mguetschow reviewed Oct 30, 2025
View reviewed changes
Copy link
Contributor

@mguetschow mguetschow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, another suggestion for clarification

@crasbe crasbe enabled auto-merge October 30, 2025 17:28
@crasbe crasbe added this pull request to the merge queue Oct 30, 2025
Merged via the queue into RIOT-OS:master with commit 1d57117 Oct 30, 2025
26 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mguetschow mguetschow mguetschow left review comments

@AnnsAnns AnnsAnns AnnsAnns approved these changes

@miri64 miri64 Awaiting requested review from miri64

@jia200x jia200x Awaiting requested review from jia200x jia200x is a code owner

Assignees

No one assigned

Labels

Area: doc Area: Documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs Impact: minor The PR is small in size and might only require a quick look of a knowledgeable reviewer Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@crasbe @riot-ci @AnnsAnns @mguetschow