Mention options for correcting formatting issues when taking the "Quick fix" approach to contributing #3587
Conversation
This file contains 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
…ck fix" approach to contributing
swar8080
force-pushed
the
swar8080-contributing-quick-fix-formatting
branch
from
be7069b to
91db7c1
Compare
svrnm
approved these changes
Nov 22, 2023
Comment on lines
+84
to
+87
| - Commenting `/fix:format` on your pull request to trigger an automated script. | ||
| This requires a unique branch name, which can be edited under _View all | ||
| branches_ in your fork. | ||
|
|
There was a problem hiding this comment.
Let's add this in for now, but eventually I want to fix the automation script: we know what the problem is (if the branch name is used upstream as well the script gets "confused") and what the solution is (set the remote for the commit accordingly to the fork)
cartermp
approved these changes
Nov 22, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I followed the "Quick fixes" section of
CONTRIBUTING.mdand didn't realize a maximum line length is enforced by formatting rules. One of the maintainers suggested I use/fix:formatbut that doesn't work if the fork's branch name also exists in this repo. By default, github uses a branch name ofpatch-Nwhen editing files from the browser, so a clash is likelyHopefully calling this out will save contributors/reviewers time resolving formatting issues