Skip to content

Commit 3b55b48

Browse files
fixup! [enhancement] Add description about code quality checks
1 parent 8c8cdd8 commit 3b55b48

1 file changed

Lines changed: 20 additions & 1 deletion

File tree

CONTRIBUTING.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,9 +100,28 @@ from product_db_access_handler import ThriftProductHandler
100100
### Code quality
101101

102102
Any change in the Pull Request against the codechecker repository will be checked
103-
with CodeChecker itself for potential issues. If any issue found, the Pull Request
103+
with CodeChecker itself for potential issues. If any new issue found, the Pull Request
104104
cannot be merged before fixing them.
105105

106+
#### Running quality check locally
107+
108+
Quality check script can also be used locally which needs setting up the environment before the first run:
109+
110+
* Create a local settings file for automatically logging in to the CodeChecker Code Quality server
111+
112+
``` json
113+
{
114+
"client_autologin" : true,
115+
"credentials": {
116+
"https://codechecker-demo.eastus.cloudapp.azure.com": "codechecker:codechecker"
117+
}
118+
}
119+
```
120+
121+
* Run `ci/github_analysis/codechecker_gate_pr.sh` to analyze the code.
122+
123+
__Important:__ Make sure you are running CodeChecker 6.25.1 when running the script!
124+
106125
### Directory layout
107126

108127
#### `analyzer`

0 commit comments

Comments
 (0)