From c9310455bc3263a3188332c5236074b0f7be73d6 Mon Sep 17 00:00:00 2001 From: Joshua Wilson Date: Sun, 19 Apr 2026 23:30:20 +0000 Subject: [PATCH] update agents to include PR workflow --- AGENTS.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/AGENTS.md b/AGENTS.md index a5bebb4e8..6283c4502 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -112,6 +112,32 @@ Available skills for code review: Invoke by typing `/skill-name` in chat. +## Git and PR Workflow + +### Commit Messages +- Start with the Jira ticket reference: `OLS-XXXX description` +- Keep the first line under 72 characters +- Use imperative mood + +### Pull Requests +This repo uses a **fork-based workflow**: + +1. **Push to your fork**, not to `origin` (openshift/lightspeed-operator) +2. **Create the PR** against `origin/main` using your fork's branch: + ```bash + git push + gh pr create --repo openshift/lightspeed-operator --head : --base main + ``` +3. **PR title** must start with the Jira reference: `OLS-XXXX description` +4. **Squash commits** before pushing -- one logical commit per PR unless the PR explicitly tracks multiple independent changes + +### Branch Completion +When finishing a development branch: +1. Remove any process artifacts (design docs, plans in `docs/superpowers/`) +2. Squash commits with the Jira-prefixed message +3. Push to the contributor's fork remote (not `origin`) +4. Create the PR against `origin/main` using `--head :` + ## Maintaining This Document Always suggest AGENTS.md edits when architectural, structural, or conventional changes are made to the codebase.