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

Minor improvements to "rebase needed" workflow #93

Closed
bsmth opened this issue Dec 19, 2022 · 2 comments
Closed

Minor improvements to "rebase needed" workflow #93

bsmth opened this issue Dec 19, 2022 · 2 comments

Comments

@bsmth
Copy link
Member

bsmth commented Dec 19, 2022

I have two suggestions to improve the rebase needed workflow:

Rebase wording:

Regarding the wording in https://github.com/mdn/workflows/blob/main/.github/workflows/pr-rebase-needed.yml

We should maybe rephrase that rebasing is needed. Per the CONTRIBUTING.md we say:

Don't use git rebase of main over your branch. Your changes are replayed on top of the current main branch at that point in time. This might confuse reviewers as notifications on GitHub lead to nowhere.

Should we say that the branch needs to be "updated from main" or the author must "resolve merge conflicts" instead as we discourage rebasing?

Comments:

We might want to reduce the number of new comments this is adding each time a rebase is needed. Alternatively, edit existing comments with a strikethrough when it's been resolved. The PR companion workflow is nice because there is one comment which is updated with the last-known state. See mdn/interactive-examples#2288 for example.

@bsmth
Copy link
Member Author

bsmth commented Feb 8, 2023

Note that "sticky" pull request comment edits a comment in-place instead of adding new ones to a PR: https://github.com/marocchino/sticky-pull-request-comment

@bsmth
Copy link
Member Author

bsmth commented Mar 3, 2023

I'm going to close this as part 1 (rebasing wording) is done. Tracking the rest in #120

@bsmth bsmth closed this as completed Mar 3, 2023
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

No branches or pull requests

1 participant