Skip to content

Commit 3dee21f

Browse files
committed
all: add GEMINI.md
Add an initial version of the GEMINI.md file for use by coding agents.
1 parent 5575662 commit 3dee21f

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

GEMINI.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Project: syzkaller / syzbot
2+
3+
## General Instructions
4+
5+
Prefer to use the `syz-env` Docker container to build and run tests. There's a `./tools/syz-env` script that will start a container and run the given command inside it.
6+
7+
Some reference commands:
8+
* Linter checks: `CI=true ./tools/syz-env make lint`
9+
* Run a test: `CI=true ./tools/syz-env go test ./package -run TestName`
10+
11+
Note the `CI=true` part - otherwise the commands may not run in your environment.
12+
13+
Err on the side of adding tests for your changes. For some packages (e.g. `./dashboard/app` or `./prog`), we strive to have a very high test coverage. When adding a test, carefully look at the other tests in the same package to understand the style and structure.
14+
15+
When running tests (especially in `./prog` and `./pkg/csource`) prefer to run individual tests you have affected, otherwise it may take a lot of time. Some packages also offer a `-short` flag to run a lighter version of tests.
16+
17+
It may be necessary to first run `CI=true ./tools/syz-env make descriptions` to pre-build descriptions for the `sys/*` targets. It may be necessary for all tests that eventually use `prog.Target` or `targets.Target`.
18+
19+
Refer to the documentation in `docs/` regarding syzlang syntax and instructions for various syzkaller tools.
20+
21+
When you add new .go files, make sure to add the copyright header to them (use other .go files for reference and update the year to the current one).

0 commit comments

Comments
 (0)