Skip to content

Commit f9e1c4c

Browse files
committed
Initial developer guide.
1 parent 01d7bee commit f9e1c4c

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,3 +70,22 @@ Please [create GitHub issues](https://github.com/advanced-security/brew-dependen
7070
<!-- Resources / Links -->
7171

7272
[configurations]: ./configs
73+
74+
## Developer Guide
75+
76+
This is not a comprehensive guide on, how to make contributions to this repository, but only a minimal list of, what you need to do to set up a development environment and how changes can be tested using the DCA tool.
77+
78+
### Set up environment
79+
To run the queries locally (including tests) you need to
80+
- Clone this repository.
81+
- Clone `https://www.github.com/github/codeql` into a folder named `codeql` in the folder created in the previous step.
82+
83+
### Testing using DCA
84+
It is possible to test PR changes for all languages against the default (nightly) source suite using DCA.
85+
As a pre-requisite you need to install and setup [DCA](https://github.com/github/codeql-dca?tab=readme-ov-file#codeql-dca-dist-compare-on-actions).
86+
87+
After DCA has been installed, you can start an experiment using the following command (with suitable substitutions for the parameters in angle brackets)
88+
```
89+
./dca generate --language <language> <semmle-code-sha0>@<community-pack-sha0> <semmle-code-sha1>@<community-pack-sha1> --extra-config-file dca-configs/community-packs.yml
90+
./dca start
91+
```

0 commit comments

Comments
 (0)