Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## Contributing

[fork]: https://github.com/github/REPO/fork
[pr]: https://github.com/github/REPO/compare
[fork]: https://github.com/advanced-security/codeql-qtil/fork
[pr]: https://github.com/advanced-security/codeql-qtil/compare
[code-of-conduct]: CODE_OF_CONDUCT.md

Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
Expand Down Expand Up @@ -30,7 +30,7 @@ The next step, after registering and discussing your improvement, is proposing t
5. Ensure the files are appropriately formatted: QL files should be formatted with `codeql query format`.
6. Create new tests for any new features or changes to existing features. Ensure all existing tests pass. Tests can be run with `codeql test run $DIR`, where `$DIR` is either `/test` in the repo root, or `$LANG/test` for a specific language.
7. If relevant, ensure the change will be applied to all languages supported by qtil. Exceptions can be applied if necessary.
8. Push to your fork and [submit a draft pull request](https://github.com/github/codeql-coding-standards/compare). Make sure to select **Create Draft Pull Request**.
8. Push to your fork and [submit a draft pull request](https://github.com/advanced-security/codeql-qtil/compare). Make sure to select **Create Draft Pull Request**.
9. Address failed checks, if any.
10. Mark the [pull request ready for review](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request#marking-a-pull-request-as-ready-for-review).
11. Pat your self on the back and wait for your pull request to be reviewed and merged.
Expand Down
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Let's dive in!

This project is licensed under the terms of the MIT open source license. Please refer to [MIT](./LICENSE.txt) for the full terms.

CodeQL is subject to the [GithHub CodeQL Terms & Conditions](https://securitylab.github.com/tools/codeql/license).
CodeQL is subject to the [GitHub CodeQL Terms & Conditions](https://securitylab.github.com/tools/codeql/license).

## Background

Expand Down Expand Up @@ -49,7 +49,7 @@ To use `qtil`, you can either import everything at once, or pick what you need:
import qtil.Qtil
class MyPair extends Qtil::Pair<...> { ... }

// or import what you need with no namepsace
// or import what you need with no namespace
import qtil.tuple.Pair
class MyPair extends Pair<...> { ... }
```
Expand Down Expand Up @@ -135,7 +135,7 @@ class AgeOrderedCityPerson extends Qtil::Ordered<Person>::GroupBy<City>::Type {

// Selects people, along with the next youngest and next oldest in the same city.
from AgeOrderedCityPerson p
select p.getName(), p.getCity(), p.getPrevious.getName(), p.getNext.getName()
select p.getName(), p.getCity(), p.getPrevious().getName(), p.getNext().getName()
```

**CondensedList**: Like the `Ordered` class, but creates a separate `ListEntry` type rather than
Expand Down Expand Up @@ -183,8 +183,8 @@ select Qtil::Escape<Qtil::defaultEscapeMap/2>::escape("foo\\bar\nbaz"),
select Qtil::doubleQuoteWrap("foo\"bar\\baz"), Qtil::unescapeDoubleQuote("\"foo\\\"bar\\\\baz\"")

// CSV-like functionality: result is "foo\\,bar,baz\\\\qux", "foo,bar"
select Qtil::SeparatedEscape<Qtil::Chars::comma\0>::EscapeBackslash::of2("foo,bar", "baz\\qux"),
Qtil::SeparatedEscape<Qtil::Chars::comma\0>::split("foo\\,bar,baz\\\\qux", Qtil::charOf("\\"), 0)
select Qtil::SeparatedEscape<Qtil::Chars::comma/0>::EscapeBackslash::of2("foo,bar", "baz\\qux"),
Qtil::SeparatedEscape<Qtil::Chars::comma/0>::split("foo\\,bar,baz\\\\qux", Qtil::charOf("\\"), 0)
```

Escaping characters will carefully escape and unescape themselves. See documentation on escape maps
Expand Down Expand Up @@ -350,7 +350,7 @@ primitives) require special care, which `InfInstance` handles correctly, allowin
some contexts, such as parameterized modules. Simply extend `Qtil::Final<T>::Type` instead of
declaring a final alias type.

```
```ql
// Use CodeQL "final" extension:
class MyFoo1 extends Qtil::Final<Foo>::Type { ... }

Expand Down Expand Up @@ -464,7 +464,7 @@ fails, the result of each test will be selected (including failing and passing t
For correct use, ensure that each test class passes with a unique name, and that tests always hold
for some result, whether its a pass or a fail.

```
```ql
override predicate run(Qnit test) {
if 1 = 1
then test.pass("1 equals 1") // Ensure this is unique to the test
Expand Down Expand Up @@ -493,7 +493,7 @@ module MyModule<binary/2 binop> { ... }

This module allows you to write:

```
```ql
module MyModule<Qtil::Binary<int, int>::pred/2 binop> { ... }
```

Expand Down Expand Up @@ -563,5 +563,5 @@ receiving timely support amidst our busy jobs here at GitHub!

## Maintainers

This project is currently maintained by @michaelrfairhurst with help from other CodeQL/security
experts at GitHub.
This project is currently maintained by CodeQL/security/code quality experts. Support on any given
day is likely to come from @michaelrfairhurst.