Jason Thistlethwaite
30 lines
1.1 KiB
Markdown
30 lines
1.1 KiB
Markdown
# cronScripts Repository Conventions
|
|
|
|
This repository is the source-of-truth for script jobs and automation tasks.
|
|
|
|
## Required structure
|
|
|
|
- `~/projects/cronScripts/` contains one folder per task/script/job.
|
|
- Each task folder contains the shippable, finished copy of the work product(s).
|
|
- Runtime/deployed copies can exist elsewhere (for example `~/.hermes/scripts/`), but this repo must keep the canonical version under the task folder.
|
|
|
|
## Required files per task folder
|
|
|
|
Every task folder must include:
|
|
|
|
- `README.md` - what the script/job is and how it works.
|
|
- `INSTALL.md` - exact setup/install steps to begin using it.
|
|
- `HANDOFF.md` - brief status and checklist of completed + pending work.
|
|
|
|
## HANDOFF policy (mandatory)
|
|
|
|
- `HANDOFF.md` must exist for every script/task folder.
|
|
- `HANDOFF.md` must be updated whenever any agent modifies anything in this git repo.
|
|
- Updates must include:
|
|
- what was changed (checked items), and
|
|
- any remaining next steps (unchecked items).
|
|
|
|
## Practical rule
|
|
|
|
Regardless of external install/use instructions, the finished, shippable copy of each script/job must be committed in this repo's task-folder structure.
|