Skip to content

Optimize PR processes#1538

Merged
tk-o merged 4 commits intomainfrom
optimize-pr-templates
Jan 16, 2026
Merged

Optimize PR processes#1538
tk-o merged 4 commits intomainfrom
optimize-pr-templates

Conversation

@lightwalker-eth
Copy link
Copy Markdown
Member

@lightwalker-eth lightwalker-eth commented Jan 16, 2026

Lite PR

Summary

  • Refines PR templates.
  • Lite template is now default.
  • Constraints use of substantial template only for substantial changes.
  • Optimizes PR description checks action in CI:
    • Only triggers on non-draft PRs.
    • Includes advice in PR template tips.

Why

  • Builds on learnings from the past few weeks of using these PR templates.
  • Encourage more use of the Lite PR template as a default except for more substantial changes.

Testing

  • Verified that toggling between draft / non-draft PR status with unchecked PR description checkboxes worked as expected.

Pre-Review Checklist (Blocking)

  • This PR does not introduce significant changes and is low-risk to review quickly.
  • Relevant changesets are included (or are not required)
PR Creation Tips
  • If this PR introduces significant changes or is higher-risk to review use the "Substantial PR" template instead.
  • Changesets should optimize for the narrative of the next autogenerated release notes. Optimize for how the resulting release notes will read to a developer in the ENS Ecosystem. Communicate all ideas with a positive frame.
  • The "Require PR Description Checks" GitHub Action will report a failing CI check on non-draft PRs where there are unchecked checkboxes in the description. You should therefore make your PR a draft PR until it is ready for review.

@lightwalker-eth lightwalker-eth requested a review from a team as a code owner January 16, 2026 17:14
Copilot AI review requested due to automatic review settings January 16, 2026 17:14
@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Jan 16, 2026

⚠️ No Changeset found

Latest commit: 1f852ca

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel
Copy link
Copy Markdown
Contributor

vercel Bot commented Jan 16, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Review Updated (UTC)
admin.ensnode.io Ready Ready Preview, Comment Jan 16, 2026 5:44pm
ensnode.io Ready Ready Preview, Comment Jan 16, 2026 5:44pm
ensrainbow.io Ready Ready Preview, Comment Jan 16, 2026 5:44pm

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR optimizes the GitHub PR template structure by making the Lite PR template the default, removing the template chooser, and encouraging developers to use the substantial template only for significant changes.

Changes:

  • Replaced the template chooser with the Lite PR template as the default
  • Updated the substantial template's description to be more concise
  • Added consistent changeset guidance to both templates

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File Description
.github/pull_request_template.md Replaced template chooser with Lite PR template as default, includes checklist to guide users to substantial template when needed
.github/PULL_REQUEST_TEMPLATE/substantial.md Simplified description and added changeset tip consistent with default template
.github/PULL_REQUEST_TEMPLATE/lite.md Deleted as its content is now the default template

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread .github/pull_request_template.md Outdated
Comment thread .github/pull_request_template.md Outdated
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented Jan 16, 2026

Greptile Summary

This PR streamlines the PR template system by making the Lite PR template the default, eliminating the need for template selection for most PRs.

Key changes:

  • Deleted .github/PULL_REQUEST_TEMPLATE/lite.md and moved its content to the default pull_request_template.md
  • Updated default template to include collapsible "PR Creation Tips" section with guidance on when to use the Substantial PR template
  • Refined substantial template wording from "change behavior, introduce new concepts, or would hurt if they broke" to "introduce significant changes"
  • Renamed workflow from "Require PR Checks" to "Require PR Description Checks" with improved draft PR handling
  • Added helpful changeset tips to both templates

This change encourages developers to use the lighter template by default while still providing clear guidance for when to upgrade to the substantial template.

Confidence Score: 5/5

  • This PR is safe to merge with no risks
  • Changes are purely to documentation templates and a non-critical GitHub Action workflow; no runtime code affected; clear improvements to developer experience; all links and references are valid
  • No files require special attention

Important Files Changed

Filename Overview
.github/pull_request_template.md Converted from template chooser to Lite PR template as default; clear structure with helpful tips section
.github/PULL_REQUEST_TEMPLATE/substantial.md Minor wording refinements and added changeset tip; maintains comprehensive structure
.github/workflows/require_pr_description_checks.yml Renamed for clarity and added draft PR skip logic; improved trigger conditions

Sequence Diagram

sequenceDiagram
    participant Dev as Developer
    participant GH as GitHub
    participant Lite as Lite Template (Default)
    participant Sub as Substantial Template
    participant Action as PR Description Check Action

    Dev->>GH: Create new PR
    GH->>Lite: Load default template
    Lite->>Dev: Display Lite PR template
    
    alt PR has significant changes
        Dev->>GH: Click "Substantial PR" link
        GH->>Sub: Load substantial template
        Sub->>Dev: Display comprehensive template
    end
    
    Dev->>GH: Fill in template & create PR
    
    alt PR is draft
        Action->>Action: Skip checks (draft PR)
    else PR is ready for review
        Action->>GH: Check for unchecked boxes
        alt Has unchecked boxes
            Action->>GH: Report failing check
        else All boxes checked
            Action->>GH: Pass check
        end
    end
Loading

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented Jan 16, 2026

Greptile's behavior is changing!

From now on, if a review finishes with no comments, we will not post an additional "statistics" comment to confirm that our review found nothing to comment on. However, you can confirm that we reviewed your changes in the status check section.

This feature can be toggled off in your Code Review Settings by deselecting "Create a status check for each PR".

@lightwalker-eth lightwalker-eth marked this pull request as draft January 16, 2026 17:32
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

Comments suppressed due to low confidence (1)

.github/workflows/require_pr_description_checks.yml:5

  • The workflow includes converted_to_draft as a trigger but the job has a condition to skip on draft PRs (if: ${{ github.event.pull_request.draft != true }}). This means when a PR is converted to draft, the workflow will trigger and immediately skip, which is unnecessary overhead. Consider removing converted_to_draft from the trigger types since the workflow doesn't need to run when a PR becomes a draft.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread .github/pull_request_template.md
Copy link
Copy Markdown
Member Author

@lightwalker-eth lightwalker-eth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Self-review completed.

on:
pull_request:
types: [opened, edited, synchronize]
types: [opened, reopened, edited, ready_for_review, converted_to_draft]
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • synchronize (for new code pushes) is not relevant for this action which doesn't consider code at all.
  • reopened maybe isn't relevant but added it under an assumption it might be useful.
  • ready_for_review and converted_to_draft are important now based on the new rule to disable this check for draft PRs.

@lightwalker-eth lightwalker-eth changed the title Optimize PR templates Optimize PR processes Jan 16, 2026
Copy link
Copy Markdown
Member

@tk-o tk-o left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@tk-o tk-o merged commit d27f02e into main Jan 16, 2026
23 of 26 checks passed
@tk-o tk-o deleted the optimize-pr-templates branch January 16, 2026 18:51
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.

3 participants