The code and data behind xeiaso.net
docs: add project guidelines and agent documentation
Add AGENTS.md with repository structure, build commands, coding standards,
and commit guidelines. Add CLAUDE.md to reference the agent documentation.
+44
+43
AGENTS.md
+43
AGENTS.md
···
1
+
# Repository Guidelines
2
+
3
+
## Project Structure & Module Organization
4
+
- `cmd/` – entry‑point binaries (e.g., `xesite`, `patreon-saasproxy`). Each subdirectory contains a `main.go`.
5
+
- `internal/` – reusable Go packages for core logic.
6
+
- `dhall/` – configuration files written in Dhall, used by the site generator.
7
+
- `lume/` – static content (blog posts, videos) in Markdown/MDX.
8
+
- `scripts/` – helper scripts (e.g., `fabricate-generation`, `imgoptimize`).
9
+
- `manifest/` – Kubernetes manifests for deployment.
10
+
- `var/` – generated artifacts (compiled binaries, assets).
11
+
12
+
## Build, Test, and Development Commands
13
+
- `go build ./cmd/xesite` – compile the main site binary.
14
+
- `go run ./cmd/xesite --site-url https://preview.xeiaso.net --devel` – start the dev server (see `package.json` script `dev`).
15
+
- `npm run dev` – alias for the above Go command.
16
+
- `npm run deploy` – deploy the site to production.
17
+
- `go test ./...` – run any Go tests (currently none).
18
+
19
+
## Coding Style & Naming Conventions
20
+
- Go code follows `gofmt`; run `go fmt ./...` before committing.
21
+
- Use `camelCase` for variables/functions, `PascalCase` for exported types.
22
+
- Indentation: tabs (default `go fmt`).
23
+
- Dhall files use kebab‑case filenames (e.g., `my-config.dhall`).
24
+
- Bash/Node scripts use `snake_case` for variable names.
25
+
26
+
## Testing Guidelines
27
+
- Add tests using the `testing` package; name files `*_test.go` and place them alongside the package.
28
+
- Run `go test ./...` to execute all tests.
29
+
30
+
## Commit & Pull Request Guidelines
31
+
- Commit messages follow the conventional format:
32
+
- `type(scope): short description`
33
+
- Example: `feat(cli): add --site-url flag`.
34
+
- Keep commits atomic and self‑contained.
35
+
- PR description must include:
36
+
- Summary of changes.
37
+
- Related issue number (if any).
38
+
- Verification steps (e.g., run `go run ./cmd/xesite`).
39
+
40
+
## Security & Configuration Tips
41
+
- Secrets live in `.env` and must never be committed; `.gitignore` already excludes it.
42
+
- When adding new environment variables, document them in `README.md` or a dedicated config file.
43
+
+1
CLAUDE.md
+1
CLAUDE.md
···
1
+
@AGENTS.md