Skip to content

Commit 91ba125

Browse files
committed
CONTRIBUTING: document use of the @group Windows annotation
1 parent 584e004 commit 91ba125

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

.github/CONTRIBUTING.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -339,6 +339,13 @@ Example:
339339
for
340340
```
341341

342+
#### Tests covering code which has OS-specific behaviour
343+
344+
Most code in PHP_CodeSniffer is Operating System agnostic.
345+
However, there are a few places which include OS-specific conditions, most notably for Windows.
346+
347+
Tests which cover code which have Windows specific conditions should be marked with a `@group Windows` annotation to allow for running those tests separately/selectively in CI.
348+
342349

343350
### Submitting Your Pull Request
344351

0 commit comments

Comments
 (0)