codeql/README.md

# CodeQL

This open source repository contains the standard CodeQL libraries and queries that power [GitHub Advanced Security](https://github.com/features/security/code) and the other application security products that [GitHub](https://github.com/features/security/) makes available to its customers worldwide.

## How do I learn CodeQL and run queries?

There is extensive documentation about the [CodeQL language](https://codeql.github.com/docs/), writing CodeQL using the [CodeQL extension for Visual Studio Code](https://docs.github.com/en/code-security/codeql-for-vs-code/) and using the [CodeQL CLI](https://docs.github.com/en/code-security/codeql-cli).

## Contributing

We welcome contributions to our standard library and standard checks. Do you have an idea for a new check, or how to improve an existing query? Then please go ahead and open a pull request! Before you do, though, please take the time to read our [contributing guidelines](CONTRIBUTING.md). You can also consult our [style guides](https://github.com/github/codeql/tree/main/docs) to learn how to format your code for consistency and clarity, how to write query metadata, and how to write query help documentation for your query.

For information on contributing to CodeQL documentation, see the "[contributing guide](docs/codeql/CONTRIBUTING.md)" for docs.

## License

The code in this repository is licensed under the [MIT License](LICENSE) by [GitHub](https://github.com).

The CodeQL CLI (including the CodeQL engine) is hosted in a [different repository](https://github.com/github/codeql-cli-binaries) and is [licensed separately](https://github.com/github/codeql-cli-binaries/blob/main/LICENSE.md). If you'd like to use the CodeQL CLI to analyze closed-source code, you will need a separate commercial license; please [contact us](https://github.com/enterprise/contact) for further help.

## Visual Studio Code integration

If you use Visual Studio Code to work in this repository, there are a few integration features to make development easier.

### CodeQL for Visual Studio Code

You can install the [CodeQL for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-codeql) extension to get syntax highlighting, IntelliSense, and code navigation for the QL language, as well as unit test support for testing CodeQL libraries and queries.

### Tasks

The `.vscode/tasks.json` file defines custom tasks specific to working in this repository. To invoke one of these tasks, select the `Terminal | Run Task...` menu option, and then select the desired task from the dropdown. You can also invoke the `Tasks: Run Task` command from the command palette.
Update repository artifacts for name change 2019-11-01 15:05:13 +03:00			`# CodeQL`
QL code and tests for C#/C++/JavaScript. 2018-08-02 19:53:23 +03:00
Docs: Update references to github/codeql-go github/codeql-go is being merged into github/codeql. Update references to `codeql-go` within the CodeQL CLI docs. Add Go to the list of mentioned languages where applicable. Leave an explanatory note in the setup instructions about the previous requirement to check out `github/codeql-go`, and mention this is no longer necessary. The remaining references are to historical commits, which will continue to exist. 2022-05-20 21:43:23 +03:00			`This open source repository contains the standard CodeQL libraries and queries that power [GitHub Advanced Security](https://github.com/features/security/code) and the other application security products that [GitHub](https://github.com/features/security/) makes available to its customers worldwide.`
QL code and tests for C#/C++/JavaScript. 2018-08-02 19:53:23 +03:00
Update repository artifacts for name change 2019-11-01 15:05:13 +03:00			`## How do I learn CodeQL and run queries?`
QL code and tests for C#/C++/JavaScript. 2018-08-02 19:53:23 +03:00
Update README.md Co-authored-by: James Fletcher <42464962+jf205@users.noreply.github.com> 2024-05-07 15:09:08 +03:00			`There is extensive documentation about the [CodeQL language](https://codeql.github.com/docs/), writing CodeQL using the [CodeQL extension for Visual Studio Code](https://docs.github.com/en/code-security/codeql-for-vs-code/) and using the [CodeQL CLI](https://docs.github.com/en/code-security/codeql-cli).`
QL code and tests for C#/C++/JavaScript. 2018-08-02 19:53:23 +03:00
			`## Contributing`

Docs: Rename default branch 2020-08-14 13:47:53 +03:00			We welcome contributions to our standard library and standard checks. Do you have an idea for a new check, or how to improve an existing query? Then please go ahead and open a pull request! Before you do, though, please take the time to read our [contributing guidelines](CONTRIBUTING.md). You can also consult our [style guides](https://github.com/github/codeql/tree/main/docs) to learn how to format your code for consistency and clarity, how to write query metadata, and how to write query help documentation for your query.
QL code and tests for C#/C++/JavaScript. 2018-08-02 19:53:23 +03:00
Update README.md 2023-01-19 17:45:01 +03:00			`For information on contributing to CodeQL documentation, see the "[contributing guide](docs/codeql/CONTRIBUTING.md)" for docs.`
add contributing info 2023-01-05 00:43:17 +03:00
QL code and tests for C#/C++/JavaScript. 2018-08-02 19:53:23 +03:00			`## License`

Update README to clarify license explanation 2022-04-11 16:30:56 +03:00			`The code in this repository is licensed under the [MIT License](LICENSE) by [GitHub](https://github.com).`

Update README.md 2022-04-20 17:03:49 +03:00			`The CodeQL CLI (including the CodeQL engine) is hosted in a [different repository](https://github.com/github/codeql-cli-binaries) and is [licensed separately](https://github.com/github/codeql-cli-binaries/blob/main/LICENSE.md). If you'd like to use the CodeQL CLI to analyze closed-source code, you will need a separate commercial license; please [contact us](https://github.com/enterprise/contact) for further help.`
Update `README.md` with VSCode info 2020-04-24 17:36:16 +03:00
			`## Visual Studio Code integration`

			`If you use Visual Studio Code to work in this repository, there are a few integration features to make development easier.`

			`### CodeQL for Visual Studio Code`

			`You can install the [CodeQL for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-codeql) extension to get syntax highlighting, IntelliSense, and code navigation for the QL language, as well as unit test support for testing CodeQL libraries and queries.`

			`### Tasks`

			The `.vscode/tasks.json` file defines custom tasks specific to working in this repository. To invoke one of these tasks, select the `Terminal \| Run Task...` menu option, and then select the desired task from the dropdown. You can also invoke the `Tasks: Run Task` command from the command palette.