Skip to content
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.

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

doc: coding guidelines: move safety related blurb to saftey section #84058

Merged

Conversation

nashif
Copy link
Member

@nashif nashif commented Jan 15, 2025

Move some of the historical safety related langugae and enforcement strategy re
coding guidelines to the safety section.

The coding guidelines are and have been in effect for a while now, but it seems
this introduction text is confusing contributors.

Signed-off-by: Anas Nashif [email protected]

@nashif nashif force-pushed the topic/doc/coding_guidelines_stages branch from 831368c to 05c3535 Compare January 15, 2025 22:17
@nashif nashif changed the title doc: coding guidelines: move safety relate blurb to saftey section doc: coding guidelines: move safety related blurb to saftey section Jan 15, 2025
Move some of the historical safety related language and
enforcement strategy re coding guidelines to the safety section.

The coding guidelines are and have been in effect for a while now,
but it seems this introduction text is confusing contributors.

Signed-off-by: Anas Nashif <[email protected]>
@nashif nashif force-pushed the topic/doc/coding_guidelines_stages branch from 05c3535 to 7f84df6 Compare January 15, 2025 22:27
Copy link
Collaborator

@kartben kartben left a comment

Choose a reason for hiding this comment

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

Works for me to remove the confusion for folks stumbling upon coding guidelines and thinking they might not be enforced yet based on the description of the stages.
Confusion remains for anyone looking at this in its new location IMO, but that's probably for the Safety WG to help clean up in a second step.

Thanks @nashif!

@kartben kartben requested a review from de-nordic January 16, 2025 10:44
Comment on lines +161 to +162
Reviewers/approvers can block pull-requests due to violations of the coding guidelines
in pull-requests across the codebase.
Copy link
Collaborator

@de-nordic de-nordic Jan 16, 2025

Choose a reason for hiding this comment

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

This comment just highlights added section (no change requested).

Copy link
Collaborator

@de-nordic de-nordic left a comment

Choose a reason for hiding this comment

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

Thanks for the update.

@kartben kartben merged commit 3269b49 into zephyrproject-rtos:main Jan 18, 2025
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants