Skip to content

USWDS Elements - add new sections to PR template - #327

Merged
chandracarney merged 1 commit into
developfrom
task/pr-template
Sep 10, 2026
Merged

chandracarney merged 1 commit into
developfrom
task/pr-template

Conversation

@ethangardner

Copy link
Copy Markdown
Contributor

Summary

Added an AI disclosure section and an author's checklist to the pull request template so contributors report AI tool usage and confirm key quality checks before requesting review.

Breaking change

This is not a breaking change.

Problem statement

The pull request template did not ask contributors to disclose whether AI tools were used to create a change, and had no standard checklist confirming that the author validated their own work (tested locally, understands the code, verified accessibility, etc.). Without this, reviewers had no consistent signal about how a PR was produced or whether basic authorship checks had been completed, making review slower and less consistent across contributions.

Solution

Added an "AI disclosure" section with checkboxes for No AI, Chat, Completions (e.g. Copilot), and Coding Agent, so contributors can indicate what AI assistance, if any, was used. Added an "Author's checklist" section covering scope discipline, local verification, passing automated tests, manual accessibility testing with assistive technology, and the author's own understanding of the code. Both sections were inserted between the existing "Major changes" and "Testing and review" sections to keep the template's narrative flow (context → solution → self-verification → reviewer testing instructions) intact.

Major changes

  • Added "AI disclosure" section with a checklist of AI tool categories
  • Added "Author's checklist" section with pre-review self-verification items

Testing and review

This is a documentation-only change to .github/PULL_REQUEST_TEMPLATE.md. To verify, open a new pull request against this branch on GitHub and confirm the template renders correctly, the new checkboxes are interactive, and the section ordering reads sensibly alongside the existing template content.

@changeset-bot

changeset-bot Bot commented Sep 10, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: bbdcc7c

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

@chandracarney chandracarney left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thank you, looks good! This is a great step to bringing USWDS in line with other GSA repositories, and the work from the open source governance team.

@chandracarney
chandracarney merged commit 80512ec into develop Sep 10, 2026
8 checks passed
@chandracarney
chandracarney deleted the task/pr-template branch September 10, 2026 16:19
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.

2 participants