Skip to content

Conversation

@github-actions
Copy link

Description

This PR implements streamlined PR templates for the strands-agents/docs repository based on analysis of recent merged PRs. The current single template is too verbose with many sections frequently left empty. This change introduces three specialized templates to better match actual contributor usage patterns.

Resolves #7

Changes

Created Templates

  1. default.md - Main template for general documentation changes

    • Merged Description & Context section
    • Checkbox format for Type of Change (6 options)
    • Simplified 4-item checklist with "if applicable" language
    • Removed: Areas Affected, Screenshots, Additional Notes
  2. quick-fix.md - Minimal template for typos and small corrections

    • Brief description section
    • Simple Type of Fix checkboxes (4 options)
    • Files Changed list
    • 2-item checklist focused on essentials
  3. feature.md - Comprehensive template for major additions

    • Description & Motivation section
    • Related Issues linking
    • Type of Change checkboxes
    • Content Overview section
    • 5-item Testing & Validation checklist
  4. README.md - Usage guide and deployment instructions

    • Explains what each template is for
    • Documents template selection with query parameters
    • Provides deployment instructions for maintainers
    • Includes design rationale

Key Improvements

  • Simplified checklists: Reduced from 6+ items to 2-5 items based on PR type
  • Checkbox format: Type of Change uses checkboxes instead of text list (eliminates placeholder text issue)
  • Flexible templates: Three templates for different PR sizes (quick fixes, general changes, major features)
  • "If applicable" language: Reduces pressure to complete every checklist item
  • Removed empty sections: Areas Affected, Screenshots, and Additional Notes are gone
  • Merged sections: Description & Context combined for clarity

File Location

Templates are created in .github_temp/PULL_REQUEST_TEMPLATE/ (not .github/) to allow review before activation. The README includes instructions for moving files to .github/PULL_REQUEST_TEMPLATE/ during deployment.

Type of Change

  • Documentation update
  • Bug fix
  • New feature
  • Breaking change
  • Other

Testing

Since this is pure documentation, testing consists of:

  • ✅ Verified markdown syntax and rendering
  • ✅ Validated all sections match requirements from issue [FEATURE] Revamp Docs PR template #7
  • ✅ Confirmed licensing statements included in all templates
  • ✅ Checked README provides clear instructions

Manual testing will be needed after deployment:

  1. Move templates from .github_temp/ to .github/ directory
  2. Create test PRs with each template to verify they work correctly
  3. Validate query parameter selection (e.g., ?template=quick-fix.md)

Checklist

  • I have read the CONTRIBUTING document
  • My changes generate no new warnings
  • I have updated the documentation accordingly (README explains usage)
  • All acceptance criteria from issue [FEATURE] Revamp Docs PR template #7 are met

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

zastrowm and others added 4 commits December 17, 2025 16:26
- Create three PR templates: default, quick-fix, and feature
- Simplify checklists from 6+ items to 2-5 items based on PR type
- Use checkbox format for Type of Change (no placeholder text)
- Add 'if applicable' language to reduce checklist pressure
- Remove often-empty sections (Areas Affected, Screenshots, Additional Notes)
- Merge Description & Context into single section
- Include README with usage and deployment instructions

Resolves #7
@zastrowm zastrowm force-pushed the main branch 2 times, most recently from 2e05d11 to c6a56ad Compare December 31, 2025 14:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[FEATURE] Revamp Docs PR template

3 participants