Repository navigation
docs: no ConfigureAwait, and what to do when a merge is already in a PR - #2335
Merged
Merged
Conversation
…here Every host is a generic-host console app, so ConfigureAwait(false) has no synchronization context to skip and only adds noise. The 168 calls already in the tree are noted as not being a precedent rather than cleaned up here. The rebase rule existed but every open PR still carried a merge commit, so it now names the cases people actually reach for a merge in, gives the one-line check, and points at rerere for the long branches where the same conflict repeats on every commit.
|
Warning Review limit reachedNext included review available in 39 minutes. View limit detailsLimit details: You’ve used all 2 included reviews currently available. You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. Review configuration: ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Two rules, one new and one that existed but was not landing.
No
ConfigureAwaitEvery host in this repo is a generic-host console app, so there is no synchronization context to return to and
ConfigureAwait(false)is a no-op that only lengthens the line. It has been coming up in review repeatedly — #2304 carries areview: drop the ConfigureAwait(false) callscommit — so it belongs in the conventions instead.There are 168 calls already in the tree (47 in
Parser.csalone). This does not remove them; it says they are not a precedent. Happy to do the cleanup separately if you want it.Rebase, never merge
The rule was already there and every one of the seven open PRs still had a merge commit, so restating it verbatim would not have helped. What it was missing is the case people actually hit: the branch is behind, or the PR has gone un-mergeable, and a merge is the quickest way out. It now names those cases, says a merge commit already in a PR is a defect to be rebased out rather than left, and gives the check:
git log --oneline --merges origin/master..HEAD # must print nothingIt also points at
rerere, because the thing that makes rebasing feel worse than merging is a long branch replaying the same conflict on every commit.