joaomj

pr-description-draft

0
0
# Install this skill:
npx skills add joaomj/skills --skill "pr-description-draft"

Install specific skill from multi-skill repository

# Description

Write a temporary PR description markdown file at the project root from a fixed template for copy/paste into GitHub.

# SKILL.md


name: pr-description-draft
description: Write a temporary PR description markdown file at the project root from a fixed template for copy/paste into GitHub.


What I do

  • Create a temporary PR description markdown file at the project root named PR_DESCRIPTION.md
  • Populate it with the template below, verbatim
  • Complete the template by using info you gathered from git diff between remote current branch and the remote target branch (default "main").
  • Do not open a PR or change git state beyond writing the file

When to use me

Use this when the user wants a PR description they can copy into GitHub.

How I work

  1. Determine the project root. If the directory is a git repo, use the top-level root. Otherwise, use the current working directory.
  2. Create or overwrite PR_DESCRIPTION.md at the project root.
  3. Write the template below exactly as shown.
  4. Complete the file with the information you extracted from the git diff between the source remote branch and the target remote branch of this pull request the user wants to open.
  5. Report the file path to the user.

Template

# Pull Request

## Summary

**What:**

**Why:**

**Impact:**

## Related Work

-   Closes #ISSUE_ID
-   Relates to #ISSUE_ID

## Changes

-    **Feature** -
-    **Fix** -
-    **Refactor** -
-    **Docs** -
-    **Config** -

## Testing

-    Unit tests added/updated
-    Manual testing completed
-    Edge cases considered

**How to test:**

## Deployment Notes

-   **Breaking changes:**
-   **Database changes:**
-   **Config updates needed:**
-   **Third-party APIs:**

## Review Focus

## Checklist

-    Code follows style guidelines
-    No secrets or sensitive data committed
-    Documentation updated
-    CI/CD pipeline passes
-    Ready for production deployment

## Notes

# Supported AI Coding Agents

This skill is compatible with the SKILL.md standard and works with all major AI coding agents:

Learn more about the SKILL.md standard and how to use these skills with your preferred AI coding agent.