Pr Creator

Pull Request Creator

This skill guides the creation of high-quality Pull Requests that adhere to the repository's standards.

Workflow

Follow these steps to create a Pull Request:

1. Locate Template: Search for a pull request template in the repository.

   • Check .github/pull_request_template.md
   • Check .github/PULL_REQUEST_TEMPLATE.md
   • If multiple templates exist (e.g., in .github/PULL_REQUEST_TEMPLATE/), ask the user which one to use or select the most appropriate one based on the context (e.g., bug_fix.md vs feature.md).

2. Read Template: Read the content of the identified template file.

3. Draft Description: Create a PR description that strictly follows the template's structure.

   • Headings: Keep all headings from the template.
   • Checklists: Review each item. Mark with [x] if completed. If an item is not applicable, leave it unchecked or mark as [ ] (depending on the template's instructions) or remove it if the template allows flexibility (but prefer keeping it unchecked for transparency).
   • Content: Fill in the sections with clear, concise summaries of your changes.
   • Related Issues: Link any issues fixed or related to this PR (e.g., "Fixes #123").

4. Create PR: Use the gh CLI to create the PR. To avoid shell escaping issues with multi-line Markdown, write the description to a temporary file first.

   # 1. Write the drafted description to a temporary file
   # 2. Create the PR using the --body-file flag
   gh pr create --title "type(scope): succinct description" --body-file <temp_file_path>
   # 3. Remove the temporary file
   rm <temp_file_path>
   

   • Title: Ensure the title follows the Conventional Commits format if the repository uses it (e.g., feat(ui): add new button, fix(core): resolve crash).

Principles

• Compliance: Never ignore the PR template. It exists for a reason.
• Completeness: Fill out all relevant sections.
• Accuracy: Don't check boxes for tasks you haven't done.

Converted and distributed by TomeVault — claim your Tome and manage your conversions.