Skip to content

Latest commit

 

History

History
27 lines (20 loc) · 1.02 KB

File metadata and controls

27 lines (20 loc) · 1.02 KB

github-workflow-parts: agent context

GitHub workflow actions and reusable workflows.

Linux or WSL2, Docker and bash.

Working rules

  • Every command runs in the foreground, and the agent waits for it. No background commands, no subagents, no forks, no parallel tasks, even for a long commands.
  • Headers stay: short documentation still has sections.
  • Linters for YAML and Markdown are never run by an agent.
  • Commit only when asked, and never push. Shell scripts are snake_case and committed with the executable bit (git update-index --chmod=+x).
  • Documentation is as short as possible.

Writing style

Applies to Markdown, code comments, commit messages and prose in scripts.

  • A comment says why, not what, and the why is timeless.
  • One thought per line. Every sentence starts on its own line, and there is no maximum line length.
  • No em dash, no en dash. A colon, a comma, or a full stop.
  • No second person. "The working tree", not "your working tree"; <token>, not <your-token>.