Skip to content

chore: update PR template #290

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

chore: update PR template #290

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7ff4b4f
chore: update PR template
gpabst Feb 24, 2025
bad52d5
fix: add rollback and supported environments section
gpabst Feb 25, 2025
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
21 changes: 18 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,19 @@
Fixes # .
Motivation:

### What Changed?
<!-- Describe the changes you made in this PR -->
Explain here the context, and why you're making that change. What is the problem you're trying to solve.

Copy link
Contributor

Choose a reason for hiding this comment

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

Can you add a section for backwards and network compatibility? i.e. have the engineer ask the basic questions: can this change be rolled back? Will this change properly function for configured environments?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

added two sections for this, thanks for the idea!

Modifications:

Describe the modifications you've done.

Result:

After your change, what will change.

Rollback:

Describe how to rollback the changes if there is an issue and anything to look out for after the rollback.

Supported environments:

Describe the environments and network configurations where this PR will work.
Loading