Skip to content

Initial developer guide. #82

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.

Sign up for GitHub

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

Closed
wants to merge 1 commit into from
Closed

Initial developer guide. #82

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,3 +70,22 @@ Please [create GitHub issues](https://github.com/advanced-security/brew-dependen
<!-- Resources / Links -->

[configurations]: ./configs

## Developer Guide

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.

### Set up environment
To run the queries locally (including tests) you need to
- Clone this repository.
- Clone `https://www.github.com/github/codeql` into a folder named `codeql` in the folder created in the previous step.

### Testing using DCA
It is possible to test PR changes for all languages against the default (nightly) source suite using DCA.
As a prerequisite you need to install and setup [DCA](https://github.com/github/codeql-dca?tab=readme-ov-file#codeql-dca-dist-compare-on-actions).

After DCA has been installed, you can start an experiment using the following command (with suitable substitutions for the parameters in angle brackets)
```
./dca generate --language <language> <semmle-code-sha0>@<community-pack-sha0> <semmle-code-sha1>@<community-pack-sha1> --extra-config-file dca-configs/community-packs.yml
./dca start
```
Loading