Add repo conventions and cron documentation

This commit is contained in:
2026-03-28 00:17:57 +00:00
parent f1aeaeefb5
commit 1b339d5bce
7 changed files with 279 additions and 0 deletions

57
README.md Normal file
View File

@@ -0,0 +1,57 @@
# openclaw-ops
Operational repo for Ben's OpenClaw workspace.
This repo is the versioned source of truth for:
- custom skills
- scripts and helpers
- cron/automation definitions
- docs and runbooks
- core workspace guidance files
It intentionally does **not** track volatile runtime state, private memory, auth artifacts, or mailbox data.
## What is tracked
- `skills/` — custom AgentSkills and helper scripts
- `scripts/` — reusable operational scripts
- `docs/` — runbooks, architecture notes, integration docs
- `cron/` — documented recurring jobs and schedules
- selected workspace guidance files:
- `AGENTS.md`
- `SOUL.md`
- `USER.md`
- `TOOLS.md`
- `PROJECTS.md`
- `HEARTBEAT.md`
- `IDENTITY.md`
## What is not tracked
- `MEMORY.md`
- `memory/`
- `state/`
- `mail/`
- runtime/local directories like `.openclaw/`, `.opencode/`, `tmp/`
- generated caches and auth material
## Working pattern
Recommended workflow:
1. Make changes in the workspace.
2. Commit small, coherent units of work.
3. Push when the task is complete or the checkpoint is useful.
Default philosophy:
- commit often
- push deliberately
- never commit secrets
- keep operational state out of git unless intentionally templated
## Repo conventions
See `docs/repo-conventions.md` for commit/push guidance and repo hygiene.
## Cron / automation
See `cron/README.md` for the current recurring-job layout and documentation pattern.