Simplify PR template by consolidating checklists #23

New issue

Closed

opened 2025-07-06 14:03:21 -07:00 by jwilger · 1 comment

jwilger commented

2025-07-06 14:03:21 -07:00

(Migrated from github.com)

Problem

The current PR template has too many checklists (Testing, Security, Code Quality, and Reviewer), making it overwhelming and redundant. This creates unnecessary friction in the PR process.

Proposed Solution

Simplify the PR template by:

Remove the separate Testing, Security, and Code Quality checklists
Keep only the items from the current "Reviewer Checklist"
Repurpose these items to be for the PR submitter (not the reviewer)
Require these items to be checked before the PR can move out of Draft state

New Simplified Checklist

The consolidated checklist should contain only these items for the PR submitter to verify:

Code follows project style guidelines
Changes are well-documented
All tests pass
Performance implications have been considered
Security implications have been reviewed
Breaking changes are documented
The change is backward compatible where possible

Benefits

Reduces checklist fatigue
Eliminates redundancy between multiple checklists
Makes it clearer what needs to be done before a PR is ready
Maintains quality gates while simplifying the process

Implementation Notes

Update .github/pull_request_template.md
Update the PR validation workflow to check only this single simplified checklist
Keep the existing warnings about not pre-checking boxes for automation

## Problem The current PR template has too many checklists (Testing, Security, Code Quality, and Reviewer), making it overwhelming and redundant. This creates unnecessary friction in the PR process. ## Proposed Solution Simplify the PR template by: 1. **Remove** the separate Testing, Security, and Code Quality checklists 2. **Keep only** the items from the current "Reviewer Checklist" 3. **Repurpose** these items to be for the PR submitter (not the reviewer) 4. **Require** these items to be checked before the PR can move out of Draft state ## New Simplified Checklist The consolidated checklist should contain only these items for the PR submitter to verify: - [ ] Code follows project style guidelines - [ ] Changes are well-documented - [ ] All tests pass - [ ] Performance implications have been considered - [ ] Security implications have been reviewed - [ ] Breaking changes are documented - [ ] The change is backward compatible where possible ## Benefits - Reduces checklist fatigue - Eliminates redundancy between multiple checklists - Makes it clearer what needs to be done before a PR is ready - Maintains quality gates while simplifying the process ## Implementation Notes - Update `.github/pull_request_template.md` - Update the PR validation workflow to check only this single simplified checklist - Keep the existing warnings about not pre-checking boxes for automation

jwilger commented

2025-07-06 14:04:06 -07:00

(Migrated from github.com)

Additional Implementation Details for Workflow Update

The PR validation workflow (.github/workflows/pr-validation.yml) will need significant updates:

Remove validation logic for the old checklists:
- Testing checklist validation
- Security Checklist validation
- Code Quality checklist validation
Update the validation to check only the new consolidated checklist
Simplify the regex patterns since we'll only have one checklist section to validate
Update the workflow messages to reflect the new single checklist
Maintain the draft conversion logic if the consolidated checklist isn't fully checked

This will significantly simplify the workflow code while maintaining the quality gates.

## Additional Implementation Details for Workflow Update The PR validation workflow (`.github/workflows/pr-validation.yml`) will need significant updates: 1. **Remove validation logic** for the old checklists: - Testing checklist validation - Security Checklist validation - Code Quality checklist validation 2. **Update the validation** to check only the new consolidated checklist 3. **Simplify the regex patterns** since we'll only have one checklist section to validate 4. **Update the workflow messages** to reflect the new single checklist 5. **Maintain the draft conversion logic** if the consolidated checklist isn't fully checked This will significantly simplify the workflow code while maintaining the quality gates.