Skip to content

Commit 7fbad1e

Browse files
committed
improve agent tooling description
1 parent b2c10e9 commit 7fbad1e

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,16 @@ Make sure the checks passes after each change. Keep working until all checks pas
88

99
## Setup
1010

11+
Project setup uses go-task @Taskfile.dist.yaml to setup and develop the project.
12+
1113
```sh
1214
task init # Sets up dependencies, dirnev and git hooks
1315
```
1416

1517
## Install
1618

19+
Make is used to install the dotfiles since it's available on all target machines.
20+
1721
```sh
1822
# Full install (base group by default)
1923
./install
@@ -36,3 +40,18 @@ task check # runs lint checks
3640
- `base/` / `darwin/` / `thinkpad/` / etc. — actual dotfiles for each group
3741
- `install` — dotbot entrypoint; reads `DOTFILE_GROUPS` env var (comma-separated) to select which yaml configs to apply
3842
- `Makefile` — sets `DOTFILE_GROUPS` and calls `./install` for each platform target
43+
44+
## Tools
45+
46+
### GitHub
47+
48+
- Always use `gh` CLI for all GitHub operations. Never construct raw API calls.
49+
- For PRs: `gh pr view`, `gh pr diff`, `gh pr comment`
50+
- For issues: `gh issue list`, `gh issue view`
51+
- Never open GitHub browser URLs; use CLI output only
52+
53+
## What NOT to do
54+
55+
- Don't run `git push` without explicit instruction
56+
- Don't open PRs without explicit instruction
57+
- Don't edit files outside the current task scope

0 commit comments

Comments
 (0)