Skip to content

Add a note about using data providers to the CONTRIBUTING.md guide #1148

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Jun 24, 2025
Merged

Add a note about using data providers to the CONTRIBUTING.md guide #1148

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3f56ce1
Add a note about using data providers to the CONTRIBUTING.md guide
rodrigoprimo Jun 23, 2025
ad9bcc0
Update .github/CONTRIBUTING.md
rodrigoprimo Jun 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -384,6 +384,8 @@ To run the tests specific to the use of `PHP_CODESNIFFER_CBF === true`:
In such cases, the `PHP_CodeSniffer\Tests\Core\Config\AbstractRealConfigTestCase` should be used as the base test class.
* Tests for the `Runner` class often can't create their own `Config` object in the tests, so run into the same issue.
Those tests should use the `PHP_CodeSniffer\Tests\Core\Runner\AbstractRunnerTestCase` base class, which will ensure the Config is clean.
* When using data providers, define them immediately below the corresponding test method.
* When a test method has only one data provider, it is considered best practice to closely couple the test and data provider methods via their names. I.e. the data provider's name should match the test method name, replacing the "test" prefix with "data". For example, the data provider for a method named `testSomething()` should be `dataSomething()`.

### Submitting Your Pull Request

Expand Down