`RULE-13-5`: Improve reporting to clarify type of side effect

Open
#767 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
42/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
cpp
Domain
devtools

Research direction

Start by locating the RULE-13-5 query and reviewing how it currently reports highlighted side effects. Identify the side-effect categories the query can detect, including access to a volatile variable, and make the report distinguish the relevant type. Done means reported results explain which kind of side effect was found.

Written by the indexing model from the issue text.

Description

enhancement Standard-MISRA-C

The query doesn't currently report what type of side effect is highlighted. This can make it difficult to identify why correct results are reported, as some side-effects aren't that obvious, such as accessing a volatile variable.

Dominant language
CodeQL
Stars
227
Forks
82
Avg merge
6d 7h
Merged PRs (30d)
9

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from github/codeql-coding-standards

All issues in github/codeql-coding-standards

Similar issues

More DevTools issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.