Create Pull Request

Creates GitHub PRs with clear, descriptive titles.

PR Title Format

<ID/Scope>: <summary>

ID/Scope

The ID is extracted from the current branch name or a logical scope is used.

Examples:

Summary Rules

• •Use imperative present tense: "Add" not "Added"
• •Capitalize first letter
• •No period at the end
• •Be concise but descriptive

Steps

1. •

   Check current state:

   bash

   git status
   git diff --stat
   git log origin/main..HEAD --oneline
   

2. •

   Determine ID:

   • •Attempt to extract an ID from the current branch name.
   • •If no ID is strictly present, use the branch type (feature, fix) or project scope.
3. •

   Analyze changes to determine:

   • •Summary: What does the change do?
4. •

   Validate Plan Completion:

   • •Locate the relevant plan.md (usually in specs/<ID>-<name>/plan.md).
   • •Check if all checkboxes in the plan are marked as completed ([x]).
   • •MANDATORY: A PR should not be created if there are pending [ ] items in the plan.md unless explicitly justified.
5. •

   Push branch if needed:

   bash

   git push -u origin HEAD
   

6. •

   Create PR using gh CLI:

   bash

   gh pr create --draft --title "${ID}: <summary>" --body "$(cat <<'EOF'
   ## Description
   
   <Describe what the PR does and how to test. Photos and videos are recommended.>
   
   ## Type of change
   
   - [ ] Bug fix
   - [ ] New feature
   - [ ] Improvement
   - [ ] Breaking change
   
   ## How Has This Been Tested?
   
   - [ ] Unit tests
   - [ ] Integration tests
   - [ ] Manual testing
   
   ## Checklist:
   
   - [ ] My code follows the style guidelines of this project
   - [ ] I have performed a self-review of my own code
   - [ ] I have commented my code, particularly in hard-to-understand areas
   - [ ] I have made corresponding changes to the documentation
   - [ ] I have updated the implementation plan (plan.md)
   - [ ] New and existing unit tests pass locally with my changes
   - [ ] I have checked my code and corrected any misspellings
   EOF
   )"
   

PR Body Guidelines

Description Section

• •Describe what the PR does
• •Explain how to test the changes
• •Include screenshots/videos for UI changes

Type of Change

Select the appropriate type:

• •Bug fix - Fixes an issue
• •New feature - Adds new functionality
• •Improvement - Enhances existing functionality
• •Breaking change - Changes that break backward compatibility

Testing Section

Describe how the changes were tested

Checklist

All items should be addressed before merging

Validation

The PR title should generally match this pattern:

^[^:]+: [A-Z].+[^.]$