chore(copilot): instruct to not duplicate tests #414
Conversation
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
Clarified instructions on adding separate unit tests for the same regex pattern.
aaronliu0130
temporarily deployed
to
testpypi
GitHub Actions
Inactive
aaronliu0130
temporarily deployed
to
testpypi
GitHub Actions
Inactive
There was a problem hiding this comment.
Pull request overview
This PR adds GitHub Copilot instructions for Python files to prevent duplication of unit tests that only differ by alternatives within the same regex alternation group. The instructions guide developers to test structural parts of regex patterns without exhaustively testing every alternative in an alternation.
Key Changes
- Added new GitHub Copilot instruction file for Python files (
.github/instructions/*.py.instructions.md) - Defined testing guidelines for regex pattern unit tests
- Provided clear example using C++ standard library types to illustrate the principle
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Member
Author
|
Perhaps we should drop this in favor of #416. |
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.
Clarified instructions on adding separate unit tests for the same regex pattern.
Original draft:
Throughout the unit tests, each part of the relevant regex pattern is only tested once. Do not add new test cases if the only difference to an existing test case is the replacement of a word already included as an alternate in a regex that is already tested. For example, there should be separate test cases for
std::pair<int,int>andstd::vector<int>even if they are part of the same regex, but after these two test cases are added, there should not be a separate test case forstd::list<int>as it is simply testing thevector|listpart of said regex.