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

Relax wording of branch up-to-date in PR template #1705

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

sfc-gh-fcampbell
Copy link
Contributor

Pre-review checklist

  • I've confirmed that instructions included in README.md are still correct after my changes in the codebase.
  • I've added or updated automated unit tests to verify correctness of my new code.
  • I've added or updated integration tests to verify correctness of my new code.
  • I've confirmed that my changes are working by executing CLI's commands manually on MacOS.
  • I've confirmed that my changes are working by executing CLI's commands manually on Windows.
  • I've confirmed that my changes are up-to-date with the target branch.
  • I've described my changes in the release notes.
  • I've described my changes in the section below.

Changes description

It's no longer a requirement for PRs to be up-to-date when merging, but we still want to remind users to keep their PRs reasonable up to date with the target branch (within about a day or so) to reduce the chance of logical conflicts between two PRs that get merged close to each other.

@sfc-gh-fcampbell sfc-gh-fcampbell requested a review from a team as a code owner October 10, 2024 21:03
@@ -4,7 +4,7 @@
* [ ] I've added or updated integration tests to verify correctness of my new code.
* [ ] I've confirmed that my changes are working by executing CLI's commands manually on MacOS.
* [ ] I've confirmed that my changes are working by executing CLI's commands manually on Windows.
* [ ] I've confirmed that my changes are up-to-date with the target branch.
* [ ] I've confirmed that my changes are reasonably up-to-date with the target branch.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm open to ideas about the wording, I just didn't want to be too prescriptive about how long is too long to go without a merge/rebase

Copy link
Contributor

Choose a reason for hiding this comment

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

I don't know why this check box exists anyway, since we tend to delay rebasing during the review cycle anyway. This checkbox goes stale almost immediately after the PR is published.

If the intention is to remind devs to always submit the initial PR from the tip of main, then the wording is arguably fine, or we can say something like "I confirm that at the time of publishing the initial review, my changes are up-to-date with the target branch".

@sfc-gh-fcampbell sfc-gh-fcampbell enabled auto-merge (squash) October 11, 2024 14:03
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