Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <your-fork-remote> <branch>
gh pr create --repo openshift/lightspeed-operator --head <your-github-user>:<branch> --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 <user>:<branch>`

## Maintaining This Document

Always suggest AGENTS.md edits when architectural, structural, or conventional changes are made to the codebase.