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

Update Coding Standards coverage documentation #513

Merged
merged 7 commits into from
Mar 1, 2024

Conversation

lcartey
Copy link
Collaborator

@lcartey lcartey commented Jan 30, 2024

Description

This PR updates our documentation to provide greater clarity on which rules are supported for which languages and standards:

  • The README.md is updated to move the C Coding Standards to supported, and to clarify which language versions are supported.
  • The rules.csv is updated to
    • Match the language in the user manual (Queryable? -> Supportable).
    • Mark additional queries as not supportable, and provide a justification
    • Remove a spurious row
  • The user_manual.md is updated to:
    • Provide up-to-date numbers for the number of: rules, supportable rules and implemented rules.
    • Provide a short summary of which rules are not implemented.
    • Clarify additional cases why rules are not supportable (notably, when it is compiler enforced).

The implemented numbers take into consideration #512, so we should merge this after that PR is completed.

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 and others added 5 commits January 30, 2024 11:22
Update the list of supported standards.
 * Update counts of total rules, supported rules and implemented rules.
 * Expand description of what makes a rule supportable.
 * Report which rules are not implemented.
This makes it consistent with the user manual.
docs/user_manual.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@rvermeulen rvermeulen left a comment

Choose a reason for hiding this comment

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

Small change.

@rvermeulen rvermeulen added this pull request to the merge queue Mar 1, 2024
Merged via the queue into main with commit 3b08104 Mar 1, 2024
21 checks passed
@rvermeulen rvermeulen deleted the lcartey/update-supported-docs branch March 1, 2024 18:43
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