Skip to content

Declare MISRA C 2023 support complete #899

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

lcartey
Copy link
Collaborator

@lcartey lcartey commented May 15, 2025

Description

List MISRA C 2023 as completed, and update timelines on MISRA C++ 2023.

Change request type

  • Release or process automation (GitHub workflows, internal scripts)
  • Internal documentation
  • External documentation
  • Query files (.ql, .qll, .qls or unit tests)
  • External scripts (analysis report or other code shipped as part of a release)

Rules with added or modified queries

  • No rules added
  • Queries have been added for the following rules:
    • rule number here
  • Queries have been modified for the following rules:
    • rule number here

Release change checklist

A change note (development_handbook.md#change-notes) is required for any pull request which modifies:

  • The structure or layout of the release artifacts.
  • The evaluation performance (memory, execution time) of an existing query.
  • The results of an existing query in any circumstance.

If you are only adding new rule queries, a change note is not required.

Author: Is a change note required?

  • Yes
  • No

🚨🚨🚨
Reviewer: Confirm that format of shared queries (not the .qll file, the
.ql file that imports it) is valid by running them within VS Code.

  • Confirmed

Reviewer: Confirm that either a change note is not required or the change note is required and has been added.

  • Confirmed

Query development review checklist

For PRs that add new queries or modify existing queries, the following checklist should be completed by both the author and reviewer:

Author

  • Have all the relevant rule package description files been checked in?
  • Have you verified that the metadata properties of each new query is set appropriately?
  • Do all the unit tests contain both "COMPLIANT" and "NON_COMPLIANT" cases?
  • Are the alert messages properly formatted and consistent with the style guide?
  • Have you run the queries on OpenPilot and verified that the performance and results are acceptable?
    As a rule of thumb, predicates specific to the query should take no more than 1 minute, and for simple queries be under 10 seconds. If this is not the case, this should be highlighted and agreed in the code review process.
  • Does the query have an appropriate level of in-query comments/documentation?
  • Have you considered/identified possible edge cases?
  • Does the query not reinvent features in the standard library?
  • Can the query be simplified further (not golfed!)

Reviewer

  • Have all the relevant rule package description files been checked in?
  • Have you verified that the metadata properties of each new query is set appropriately?
  • Do all the unit tests contain both "COMPLIANT" and "NON_COMPLIANT" cases?
  • Are the alert messages properly formatted and consistent with the style guide?
  • Have you run the queries on OpenPilot and verified that the performance and results are acceptable?
    As a rule of thumb, predicates specific to the query should take no more than 1 minute, and for simple queries be under 10 seconds. If this is not the case, this should be highlighted and agreed in the code review process.
  • Does the query have an appropriate level of in-query comments/documentation?
  • Have you considered/identified possible edge cases?
  • Does the query not reinvent features in the standard library?
  • Can the query be simplified further (not golfed!)

@lcartey lcartey changed the title Declare misra c 2023 support complete Declare MISRA C 2023 support complete May 15, 2025
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR marks MISRA C 2023 support as complete across documentation and query suites, updates release timelines for MISRA C++ 2023, and adds a corresponding change note.

  • Add version 0.27.0 release entry and flag MISRA C 2023 as implemented in the user manual
  • Update CodeQL suite descriptions from MISRA C 2012 to MISRA C 2023 and bump README entries
  • Introduce a change note for completed MISRA C 2023 support

Reviewed Changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.

File Description
docs/user_manual.md New 0.27.0 row and table adjustments to show MISRA C 2023 as implemented
change_notes/2025-05-15-misra-c-2023.md Added change note summarizing MISRA C 2023 support completion
c/misra/src/codeql-suites/misra-c-*.qls Updated suite descriptions to reference MISRA C 2023
README.md Added MISRA C 2023 and C 2012 amendments 3 & 4 links; updated development status for C++17
Comments suppressed due to low confidence (3)

c/misra/src/codeql-suites/misra-c-mandatory.qls:1

  • The suite filename indicates a "mandatory" level but the description still reads "Advisory". Update it to "MISRA C 2023 (Mandatory)" for consistency.
- description: MISRA C 2023 (Advisory)

c/misra/src/codeql-suites/misra-c-strict.qls:1

  • Suite metadata lines must remain commented with --. Change - description: back to -- description: to preserve the CodeQL suite format.
- description: MISRA C 2023 (Strict)

change_notes/2025-05-15-misra-c-2023.md:1

  • [nitpick] Remove the leading space before the dash to ensure the top‐level bullet renders correctly in Markdown (should be - Support…).
 - Support for MISRA C 2023 is now completed.

Copy link
Contributor

@MichaelRFairhurst MichaelRFairhurst left a comment

Choose a reason for hiding this comment

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

🍾 LGTM! 🍾

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants