CONTRIBUTING: document use of the @group Windows annotation

PHPCSStandards · Nov 13, 2024 · 91ba125 · 91ba125
1 parent 584e004
commit 91ba125
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -339,6 +339,13 @@ Example:
 for
 ```
 
+#### Tests covering code which has OS-specific behaviour
+
+Most code in PHP_CodeSniffer is Operating System agnostic.
+However, there are a few places which include OS-specific conditions, most notably for Windows.
+
+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.
+
 
 ### Submitting Your Pull Request