Prompt file imported from joellis13/docugap (.github/prompts/open-pull-request_docugap.prompt.md). Fill in {{JIRA_KEY}} before use. Copyright stays with the author.

Open Pull Request

Name: open-pull-request_docugap
Author: joellis13

Triggered by: /open-pull-request or "open pull request for "

JIRA_KEY: {{input:jira_key:Jira issue key (e.g. DGAP-42)}}

Steps

1. Identify the Ticket and Branch

If the developer provided a ticket ID, use it.
Otherwise, read the ticket ID from the current Git branch name (branch names follow the pattern DGAP-####_short-description).
If you cannot determine the ticket ID, stop and ask the developer:

"Which ticket is this PR for? Please provide the ticket ID (e.g. DGAP-42)."
Confirm the current branch is not main. If it is, stop:

"You are on main. Please switch to the feature branch before opening a PR."

2. Verify the Branch is Ready

Run the following checks in order. Do not skip any step silently. If a step cannot be completed, stop and tell the developer exactly which step failed and why.

Run ./gradlew build. If the build fails, stop and report all errors to the developer. Do not open a PR with a failing build.
Check for uncommitted changes using git status. If any exist, and you have developer permission, stage and commit them with an appropriate conventional commit message before continuing.

3. Load the Plan

Read docs/implementation-plans/{{JIRA_KEY}}-plan.md to retrieve:

The story summary (used in the PR title)
The Jira issue link (used in the PR description)
The full plan content (embedded in the PR description)

If the plan file does not exist, ask the developer for the story summary and Jira URL before continuing.

4. Push the Branch

Push the current feature branch to joellis13/docugap.

5. Open a Pull Request

Open a pull request against main with the following structure:

Title: {{JIRA_KEY}}: <Story Summary>

Description:

## Description
<Brief summary of what was built and why, derived from the plan's Summary section.>

## Jira
<Full URL to the Jira issue, e.g. https://joellis13.atlassian.net/browse/DGAP-42>

## Change Log
<Bullet list of every meaningful change. Use `git log main..<branch> --oneline` to
enumerate commits as a starting point. Do not invent changes — derive from actual git history.>

## How to Test
<Step-by-step instructions a reviewer can follow to manually verify the feature works.
Derive these from the plan's Testing Strategy and Acceptance Criteria sections.>

## Verification Checklist
<Check off items that are confirmed complete. Leave unchecked anything that requires
the developer to verify locally.>

- [ ] Build passes (`./gradlew build`)
- [ ] All new tests pass
- [ ] Acceptance criteria verified manually
- [ ] No new warnings or suppressed errors introduced
- [ ] Swagger/OpenAPI docs updated (if applicable)

## Development Plan

<details>
<summary>Implementation Plan — {{JIRA_KEY}}</summary>

<paste full contents of docs/implementation-plans/{{JIRA_KEY}}-plan.md here>

</details>

6. Archive the Plan

6a. Post the plan to Jira

File attachment is not available via the Atlassian MCP. Instead, post the full contents of docs/implementation-plans/{{JIRA_KEY}}-plan.md as a Jira comment on the story, using this format:

## Implementation Plan — {{JIRA_KEY}}

<full verbatim contents of the plan file>

6b. Delete local plan files

Once the comment is confirmed posted, delete every file in docs/implementation-plans/:

rm -f docs/implementation-plans/*

If the directory is now empty, leave it in place (it is gitignored and will not appear in the PR).

7. Report to the Developer

Share the PR URL.
List any checklist items left unchecked and why.
Remind the developer:

"Review the unchecked items locally, then mark the PR ready for review when done."

Rules

Never open a PR from main to main.
Do not squash or rebase commits; leave history as-is.
The change log must be derived from the actual git history — do not invent changes.
If a merge conflict is encountered, stop immediately, notify the developer, and wait for instructions. Do not attempt to resolve conflicts autonomously.
If the branch has no commits ahead of main, stop and tell the developer there is nothing to PR.
If any required step fails (build, push, etc.), report the exact failure and wait for the developer before continuing.

# Open Pull Request Triggered by: `/open-pull-request` or "open pull request for <JIRA-KEY>" ``` JIRA_KEY: {{input:jira_key:Jira issue key (e.g. DGAP-42)}} ``` --- ## Steps ### 1. Identify the Ticket and Branch - If the developer provided a ticket ID, use it. - Otherwise, read the ticket ID from the current Git branch name (branch names follow the pattern `DGAP-####_short-description`). - If you cannot determine the ticket ID, **stop and ask the developer**: > "Which ticket is this PR for? Please provide the ticket ID (e.g. DGAP-42)." - Confirm the current branch is **not** `main`. If it is, stop: > "You are on `main`. Please switch to the feature branch before opening a PR." ### 2. Verify the Branch is Ready Run the following checks in order. **Do not skip any step silently.** If a step cannot be completed, stop and tell the developer exactly which step failed and why. 1. Run `./gradlew build`. If the build fails, stop and report all errors to the developer. Do not open a PR with a failing build. 2. Check for uncommitted changes using `git status`. If any exist, **and you have developer permission,** stage and commit them with an appropriate conventional commit message before continuing. ### 3. Load the Plan Read `docs/implementation-plans/{{JIRA_KEY}}-plan.md` to retrieve: - The story summary (used in the PR title) - The Jira issue link (used in the PR description) - The full plan content (embedded in the PR description) If the plan file does not exist, ask the developer for the story summary and Jira URL before continuing. ### 4. Push the Branch Push the current feature branch to `joellis13/docugap`. ### 5. Open a Pull Request Open a pull request against `main` with the following structure: **Title:** `{{JIRA_KEY}}: <Story Summary>` **Description:** ``` ## Description <Brief summary of what was built and why, derived from the plan's Summary section.> ## Jira <Full URL to the Jira issue, e.g. https://joellis13.atlassian.net/browse/DGAP-42> ## Change Log <Bullet list of every meaningful change. Use `git log main..<branch> --oneline` to enumerate commits as a starting point. Do not invent changes — derive from actual git history.> ## How to Test <Step-by-step instructions a reviewer can follow to manually verify the feature works. Derive these from the plan's Testing Strategy and Acceptance Criteria sections.> ## Verification Checklist <Check off items that are confirmed complete. Leave unchecked anything that requires the developer to verify locally.> - [ ] Build passes (`./gradlew build`) - [ ] All new tests pass - [ ] Acceptance criteria verified manually - [ ] No new warnings or suppressed errors introduced - [ ] Swagger/OpenAPI docs updated (if applicable) ## Development Plan <details> <summary>Implementation Plan — {{JIRA_KEY}}</summary> <paste full contents of docs/implementation-plans/{{JIRA_KEY}}-plan.md here> </details> ``` ### 6. Archive the Plan #### 6a. Post the plan to Jira File attachment is not available via the Atlassian MCP. Instead, post the full contents of `docs/implementation-plans/{{JIRA_KEY}}-plan.md` as a Jira comment on the story, using this format: ``` ## Implementation Plan — {{JIRA_KEY}} <full verbatim contents of the plan file> ``` #### 6b. Delete local plan files Once the comment is confirmed posted, delete every file in `docs/implementation-plans/`: ```bash rm -f docs/implementation-plans/* ``` If the directory is now empty, leave it in place (it is gitignored and will not appear in the PR). ### 7. Report to the Developer - Share the PR URL. - List any checklist items left unchecked and why. - Remind the developer: > "Review the unchecked items locally, then mark the PR ready for review when done." --- ## Rules - Never open a PR from `main` to `main`. - Do not squash or rebase commits; leave history as-is. - The change log must be derived from the actual git history — do not invent changes. - If a merge conflict is encountered, **stop immediately**, notify the developer, and wait for instructions. Do not attempt to resolve conflicts autonomously. - If the branch has no commits ahead of `main`, stop and tell the developer there is nothing to PR. - If any required step fails (build, push, etc.), report the exact failure and wait for the developer before continuing.

{ "prompt": "# Open Pull Request\n\nTriggered by: `/open-pull-request` or \"open pull request for <JIRA-KEY>\"\n\n```\nJIRA_KEY: {{input:jira_key:Jira issue key (e.g. DGAP-42)}}\n```\n\n---\n\n## Steps\n\n### 1. Identify the Ticket and Branch\n\n- If the developer provided a ticket ID, use it.\n- Otherwise, read the ticket ID from the current Git branch name (branch names follow the pattern\n `DGAP-####_short-description`).\n- If you cannot determine the ticket ID, **stop and ask the developer**:\n > \"Which ticket is this PR for? Please provide the ticket ID (e.g. DGAP-42).\"\n- Confirm the current branch is **not** `main`. If it is, stop:\n > \"You are on `main`. Please switch to the feature branch before opening a PR.\"\n\n### 2. Verify the Branch is Ready\n\nRun the following checks in order. **Do not skip any step silently.** If a step cannot be completed, stop and tell the\ndeveloper exactly which step failed and why.\n\n1. Run `./gradlew build`. If the build fails, stop and report all errors to the developer. Do not open a PR with a\n failing build.\n2. Check for uncommitted changes using `git status`. If any exist, **and you have developer permission,** stage and\n commit them with an appropriate conventional commit message before continuing.\n\n### 3. Load the Plan\n\nRead `docs/implementation-plans/{{JIRA_KEY}}-plan.md` to retrieve:\n\n- The story summary (used in the PR title)\n- The Jira issue link (used in the PR description)\n- The full plan content (embedded in the PR description)\n\nIf the plan file does not exist, ask the developer for the story summary and Jira URL before continuing.\n\n### 4. Push the Branch\n\nPush the current feature branch to `joellis13/docugap`.\n\n### 5. Open a Pull Request\n\nOpen a pull request against `main` with the following structure:\n\n**Title:** `{{JIRA_KEY}}: <Story Summary>`\n\n**Description:**\n\n```\n## Description\n<Brief summary of what was built and why, derived from the plan's Summary section.>\n\n## Jira\n<Full URL to the Jira issue, e.g. https://joellis13.atlassian.net/browse/DGAP-42>\n\n## Change Log\n<Bullet list of every meaningful change. Use `git log main..<branch> --oneline` to\nenumerate commits as a starting point. Do not invent changes — derive from actual git history.>\n\n## How to Test\n<Step-by-step instructions a reviewer can follow to manually verify the feature works.\nDerive these from the plan's Testing Strategy and Acceptance Criteria sections.>\n\n## Verification Checklist\n<Check off items that are confirmed complete. Leave unchecked anything that requires\nthe developer to verify locally.>\n\n- [ ] Build passes (`./gradlew build`)\n- [ ] All new tests pass\n- [ ] Acceptance criteria verified manually\n- [ ] No new warnings or suppressed errors introduced\n- [ ] Swagger/OpenAPI docs updated (if applicable)\n\n## Development Plan\n\n<details>\n<summary>Implementation Plan — {{JIRA_KEY}}</summary>\n\n<paste full contents of docs/implementation-plans/{{JIRA_KEY}}-plan.md here>\n\n</details>\n```\n\n### 6. Archive the Plan\n\n#### 6a. Post the plan to Jira\n\nFile attachment is not available via the Atlassian MCP. Instead, post the full contents of\n`docs/implementation-plans/{{JIRA_KEY}}-plan.md` as a Jira comment on the story, using this\nformat:\n\n```\n## Implementation Plan — {{JIRA_KEY}}\n\n<full verbatim contents of the plan file>\n```\n\n#### 6b. Delete local plan files\n\nOnce the comment is confirmed posted, delete every file in `docs/implementation-plans/`:\n\n```bash\nrm -f docs/implementation-plans/*\n```\n\nIf the directory is now empty, leave it in place (it is gitignored and will not appear in the PR).\n\n### 7. Report to the Developer\n\n- Share the PR URL.\n- List any checklist items left unchecked and why.\n- Remind the developer:\n > \"Review the unchecked items locally, then mark the PR ready for review when done.\"\n\n---\n\n## Rules\n\n- Never open a PR from `main` to `main`.\n- Do not squash or rebase commits; leave history as-is.\n- The change log must be derived from the actual git history — do not invent changes.\n- If a merge conflict is encountered, **stop immediately**, notify the developer, and wait for instructions. Do not\n attempt to resolve conflicts autonomously.\n- If the branch has no commits ahead of `main`, stop and tell the developer there is nothing to PR.\n- If any required step fails (build, push, etc.), report the exact failure and wait for the developer before continuing.", "variables": [ "JIRA_KEY" ], "notes": "Open a pull request for a completed feature branch Mode: agent. Tools: github, atlassian.", "metadata": { "source": { "provider": "github-prompts", "repository": "https://github.com/joellis13/docugap", "path": ".github/prompts/open-pull-request_docugap.prompt.md", "ref": "44ef35cda46dd7894f6048d0a20efc549e80aef2", "url": "https://github.com/joellis13/docugap/blob/44ef35cda46dd7894f6048d0a20efc549e80aef2/.github/prompts/open-pull-request_docugap.prompt.md", "key": "joellis13/docugap/.github/prompts/open-pull-request_docugap.prompt.md" } } }

open-pull-request_docugap

About