repos / pico

commit

aaa58cb

parent

fb28448

author

Eric Bower

date

2025-12-18 11:37:07 -0500 EST

docs: agents.md

 1@@ -0,0 +1,23 @@
 2+# Intro
 3+
 4+This is a monorepo that contains a bunch of our cloud services leveraging golang's crypto/ssh library.  @README.md has more information about what they are and how they work.
 5+
 6+# Commands
 7+
 8+```bash
 9+make fmt # format code
10+make lint # lint code
11+make test # test code
12+make build # build all go binaries
13+make check # runs all the commands above
14+```
15+
16+Before telling me a task is complete, you **must** run `make verify` before notifying me.
17+
18+# Task management
19+
20+We use a local tool called `bd` to manage tasks.  When using `bd`, work on a single task at a time.  Once you think you have finished a task, I **must** review the task before you can mark it complete.
21+
22+To learn how to use `bd` run `bd quickstart`.
23+
24+When I ask you to do something and that task is large enough that it should be broken into smaller tasks, you **must** use `bd`.

1@@ -162,3 +162,6 @@ restore:
2 	$(DOCKER_CMD) exec -it $(DB_CONTAINER) /bin/bash
3 	# psql postgres -U postgres -d pico < /backup.sql
4 .PHONY: restore
5+
6+check: fmt lint test build
7+.PHONY: check