Skip to content
This repository was archived by the owner on Sep 1, 2022. It is now read-only.

Commit d1134ff

Browse files
committed
Expand intro paragraph in README
1 parent 4395d78 commit d1134ff

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,30 @@ This repository provides Docker images and GitHub Actions
44
for use in CodeQL courses
55
on [Learning Lab](https://lab.github.com/).
66

7+
These actions allow you to specify workflows
8+
that can check that course participants' queries are correct,
9+
by running their queries against a well-known CodeQL database,
10+
and checking the results are as expected.
11+
Whatever the outcome,
12+
the action will post a comment on the commit which was pushed
13+
to add the queries.
714

15+
When a user's results are incorrect,
16+
the comment will include details of which results are missing,
17+
and which are superfluous,
18+
including links to the lines of source code on GitHub when possible.
19+
20+
## Usage
21+
22+
TODO
23+
24+
## Example Courses
25+
26+
There are currently no published courses that use this repository,
27+
when this changes, we'll add a list here.
28+
29+
Feel free to add your own courses to this list!
30+
See [CONTRIBUTING.md](CONTRIBUTING.md).
831

932
## License
1033

0 commit comments

Comments
 (0)