Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Github: Add PR Template #3702

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
> [!TIP]
> **About PR Titles**
> The titles of all PRs will appear together on the "What's New" page, so a clear, concise explanation is important.
>
> PR titles should include page title(s), start with action verbs (e.g., Fixed, Added, Improved, Updated), and describe what was updated.
>
> For example:
> - Checkbox: Added Storybook examples
> - Experimental Components and Patterns: Improved guidance
> - Links: Fixed typos
> - Multiple Responses: Updated usage guidance

## Summary
_Provide a brief summary of what this PR does, if the title doesn't fully capture it._

## Related issue
_If this PR resolves an open issue, please add the issue number here._

Closes #[Issue_number]

## Preview link

> [!TIP]
> A preview environment is automatically created and updated with every PR (including draft PRs).
>
> Once you've committed, we run some automated checks and generate this preview environment, so it takes a minute or two.
>
> The URL of this preview environment follows this format:
>
> `https://dev-design.va.gov/[This_PR_number]`
>
> Eventually you will see an entry in the timeline similar to this:
>
> > [Your Username] deployed to development [X time] ago - with Github Actions [View Deployment]
>
> Clicking the "View Deployment" button will open a browser window to preview your changes as they will appear after being merged.
>
> **Note:** The preview environment only works for PRs submitted to the official repository. It will not work for forked repositories.

[Open Preview Environment](https://dev-design.va.gov/[This_PR_number]) ⬅️ Update with your PR preview URL
Loading