split out guideline_name_match_check
#551
Merged
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
|
Can you add a comment somewhere saying explicitly that this check is not label-overridable? (I quickly skimmed the diff but didn't see such a comment.) |
DilumAluthge
approved these changes
Jan 31, 2024
Comment on lines
+335
to
+336
| # We handle this case in `meets_name_match_check` | ||
| continue |
There was a problem hiding this comment.
It seems like it would be fine to just return false here, right? Instead of continuing?
Suggested change
| # We handle this case in `meets_name_match_check` | |
| continue | |
| # We can short-circuit in this case. | |
| return (false, "Package name matches existing package name $(other_pkg) up to case.") |
There was a problem hiding this comment.
I think it's still nice to show the list of other problems, because it helps tell them what other similar names also exist that they shouldn't use (since they will have to change their name already and might want to choose something similar)
There was a problem hiding this comment.
Oh I see. If we short-circuit now, then they don't get the full list of other name similarities.
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.
This part should not be overridable by labels. (Note this isn't a huge issue, since the consistency tests seem to catch this already, but it is helpful to have the logic clear here and to give a good message even if the label is applied removing the similarity check).